Programs

List program earning-rules daily reports

Changed on

Returns aggregated daily earning-rule evaluation statistics for the program over the given date range and resolution, optionally filtered by earning rule. Each entry counts eligibility checks for one period and earning rule. Periods without recorded activity are omitted. failures_breakdown is always an empty object. 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/earning-rules/daily

Request

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

Response

Program earning-rules daily report.

object'report' required

Object type marker. Always report.

Changes

    • warning

      deleted the path request parameter programId

    • info

      api operation id getProgramEarningRulesDailyReport removed and replaced with listProgramEarningRulesDailyReports

    • breaking

      added the new path request parameter programId

    • info

      api operation id listProgramEarningRulesDailyReports removed and replaced with getProgramEarningRulesDailyReport