Programs

List program points-earnings summary reports

Changed on

Returns total points-earnings statistics for the program (all time), optionally filtered by earning rule or card definition. Each entry sums earning operations for one earning rule, earning item, and card definition. 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/points-earnings/summary

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/reports/points-earnings/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 points-earnings 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

    • 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

  • v2be14b3318eb3Revision changes
    • breaking

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

    • breaking

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

    • 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