Programs

List program spending daily reports

Changed on

Returns aggregated points-spending statistics for the program over the given date range and resolution. Each row covers one card definition and one period with recorded spending. Periods without recorded spending are omitted. Optionally filters by card definition.

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/spending/daily

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/reports/spending/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[card_definition_id][conditions][$is]=lcdef_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Program spending daily report.

object'report' required

Object type marker. Always report.

Changes

  • v2d29b33490051Revision changes
    • warning

      for the query request parameter filters, the type of property card_definition_id/oneOf[SpendingReportFilterCardDefinitionIdConditions]/ changed from object to no type

  • v2be14b3318eb3Revision changes
    • breaking

      for the query request parameter filters, the type of property card_definition_id/oneOf[SpendingReportFilterCardDefinitionIdConditions]/ was specialized from no type to object