Programs

List program earning-rules summary reports

Changed on

Returns total earning-rule evaluation statistics for the program (all time), optionally filtered by earning rule. Includes success and failure counts with a failures breakdown. Each entry counts eligibility checks for one earning rule. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array.

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

get/v2/loyalties/programs/{programId}/reports/earning-rules/summary

Request

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

Query parameters

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 summary 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

    • warning

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

    • warning

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

    • info

      added to the ////// response property allOf list for the response status

  • v2be14b3318eb3Revision changes
    • breaking

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

    • warning

      deleted the path request parameter programId

    • info

      api operation id getProgramEarningRulesSummaryReport removed and replaced with listProgramEarningRulesSummaryReports

    • info

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

    • info

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

    • info

      removed from the ////// response property allOf list for the response status