GET rest/statistics/by-batch-id?couponBookId={couponBookId}

Gets statistics for a coupon book, divided by batches.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
couponBookId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CouponBookStatisticsByBatchId
NameDescriptionTypeAdditional information
BatchId

Gets or sets the BatchId.

string

None.

RecipientCount

Gets or sets the RecipientCount. This is the total number of persons that have received the coupon book through this BatchId.

integer

None.

TotalViewCount

Gets or sets the TotalViewCount. This is the total number of views for this coupon book.

integer

None.

UniqueViewCount

Gets or sets the UniqueViewCount. This is the number of unique recipients that have viewed this coupon book.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "batchId": "sample string 2",
    "recipientCount": 3,
    "totalViewCount": 4,
    "uniqueViewCount": 5
  },
  {
    "batchId": "sample string 2",
    "recipientCount": 3,
    "totalViewCount": 4,
    "uniqueViewCount": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfCouponBookStatisticsByBatchId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.linkmobility.com/common/coupons">
  <CouponBookStatisticsByBatchId>
    <BatchId>sample string 2</BatchId>
    <RecipientCount>3</RecipientCount>
    <TotalViewCount>4</TotalViewCount>
    <UniqueViewCount>5</UniqueViewCount>
  </CouponBookStatisticsByBatchId>
  <CouponBookStatisticsByBatchId>
    <BatchId>sample string 2</BatchId>
    <RecipientCount>3</RecipientCount>
    <TotalViewCount>4</TotalViewCount>
    <UniqueViewCount>5</UniqueViewCount>
  </CouponBookStatisticsByBatchId>
</ArrayOfCouponBookStatisticsByBatchId>