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

Gets statistics for a coupon, divided by batches.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
couponId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CouponStatisticsByBatchId
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 through this BatchId.

integer

None.

TotalViewCount

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

integer

None.

UniqueViewCount

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

integer

None.

TotalRedemptionCount

Gets or sets the TotalRedemptionCount. This is the total number of recipients that have redeemed this coupon. This might differ from for coupons that can be redeemed several times.

integer

None.

UniqueRedemptionCount

Gets or sets the UniqueRedemptionCount. This is the number of unique recipients that have redeemed this coupon.

integer

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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