Programs

List program rewards spendings daily reports

Changed on

Returns aggregated points spent on reward purchases for the program over the given date range and resolution. Each row covers one reward, reward cost, reward spending, card definition, and period with an approved point spend. Periods without an approved point spend are omitted. Optionally filters by reward, cost, spending, and card definition. A filter that matches no rows returns an empty data array.

The date range is limited per resolution:

  • 90 days for day,
  • 12 weeks for week,
  • 12 months for month,
  • 4 quarters for quarter,
  • start_date must be before end_date,
  • start_date and end_date are inclusive.

Returns 400 when query validation fails. Returns 404 when the program does not exist.

get/v2/loyalties/programs/{programId}/reports/rewards/spendings/daily

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/reports/rewards/spendings/daily
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Query parameters

start_datestring date required

Sets the inclusive start of the report date range. Format YYYY-MM-DD.

end_datestring date required

Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.

resolution'day' | 'week' | 'month' | 'quarter' required

Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.

junction'AND' | 'OR' nullable

Joins the field filters. Allowed values are AND and OR. Defaults to AND.

Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is]=lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Program rewards spendings daily report.

object'report' required

Object type marker. Always report.

Changes

  • v2d29b33490051Revision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      for the query request parameter filters, the type was generalized from object to no type

    • info

      added subschema #2 to the / response property allOf list for the response status

  • v2be14b3318eb3Revision changes
    • breaking

      for the query request parameter filters, the type changed from no type to object

    • breaking

      the / response's property type changed from no type to object for status

    • info

      api operation id getProgramRewardsSpendingsDailyReport removed and replaced with listProgramRewardsSpendingsDailyReports

    • info

      removed subschema #2 from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status