VOvoucherifyio
Programs

List program points-earnings daily reports

Changed on

Returns aggregated daily points-earnings statistics for the program over the given date range and resolution, optionally filtered by earning rule and card definition. Each entry sums earning operations recorded for one period, earning rule, earning item, and card definition. Periods without recorded activity are omitted. 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.

A successful call records no activity.

get/v2/loyalties/programs/{programId}/reports/points-earnings/daily

Request

  • Base URL
    https://api.voucherify.io
  • 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[earning_rule_id][conditions][$is]=lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Program points-earnings daily report.

object'report' required

Object type marker. Always report.

Changes

  • v26a418ac8b7b1Revision 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

    • warning

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

    • info

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

  • v23722748a6bf9Revision changes
    • warning

      deleted the path request parameter programId

    • info

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