latestOpenAPI 3.0.02026-08-1092038.0 KB

c0dcbcafc495

Generates a summary of redemptions made by all users.

Date rules:

<ul> <li>If you do not specify a start or end date, it will generate a report of the first of the current month to present.</li> <li>If you specify a start date and an end date, they cannot span more than a year.</li> <li>If you specify a start date without an end date, it will fetch either a month from start date, or the current day. Whichever is less.</li> <li>If you specify an end date without a start date, it will error.</li> </ul> All requests will include the applied start and end date.

get/v1/analytics/financial/redemptions

Query parameters

expandstring[]

Return each users' expanded data

sort'gift_card_redemptions' | 'swag_redemptions' | 'amazon_us' | 'amazon_uk' | 'amazon_ca'

Sorts output by specified value in descending order.

start-datestring date

Start Date of range to get data from as defined by RFC 3339, section 5.6, for example, 2017-07-21.

end-datestring date

End Date of range to get data from as defined by RFC 3339, section 5.6, for example, 2017-07-21. If defined, start-date is required.

Response

status'success'

Example response

{
  "data": {
    "financialRedemptionReport": [
      {
        "user": {
          "phone_number": "123-456-7890"
        }
      }
    ]
  }
}