List program spending summary reports

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/spending/summary \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "lssum_12c2bc3be20c8cb533",
      "card_definition_id": "lcdef_128f495f720c4bec8c",
      "success": 1,
      "success_on_reward": 1,
      "success_on_order": 0,
      "points": 250,
      "points_on_rewards": 250,
      "points_on_order": 0,
      "amount_on_order": 0,
      "object": "spending_summary_report"
    },
    {
      "id": "lssum_12a8242827ca244ecd",
      "card_definition_id": "lcdef_128f4a88414c4bed69",
      "success": 30,
      "success_on_reward": 10,
      "success_on_order": 20,
      "points": 7943,
      "points_on_rewards": 5000,
      "points_on_order": 2943,
      "amount_on_order": 2943,
      "object": "spending_summary_report"
    }
  ],
  "object": "report"
}

List program spending summary reports

Returns all-time point-spending totals for the program, one row per card definition that has recorded spending. Filters rows with filters[card_definition_id]. Returns at most 10 rows (max number of card definitions per program), ordered by id descending. limit and order are not query parameters.

Returns 200 with an empty data array when no spending is recorded. Returns 400 when query validation fails. Returns 404 when the program does not exist.

GET

loyalties

programs

{programId}

reports

spending

summary

List program spending summary reports

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/spending/summary \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "lssum_12c2bc3be20c8cb533",
      "card_definition_id": "lcdef_128f495f720c4bec8c",
      "success": 1,
      "success_on_reward": 1,
      "success_on_order": 0,
      "points": 250,
      "points_on_rewards": 250,
      "points_on_order": 0,
      "amount_on_order": 0,
      "object": "spending_summary_report"
    },
    {
      "id": "lssum_12a8242827ca244ecd",
      "card_definition_id": "lcdef_128f4a88414c4bed69",
      "success": 30,
      "success_on_reward": 10,
      "success_on_order": 20,
      "points": 7943,
      "points_on_rewards": 5000,
      "points_on_order": 2943,
      "amount_on_order": 2943,
      "object": "spending_summary_report"
    }
  ],
  "object": "report"
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

programId

string

required

Identifies the loyalty program. Format lprg_[a-f0-9]+.

Pattern: ^lprg_[a-f0-9]+$

Query Parameters

filters

object

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. Filters for spending reports.

Show child attributes

Response

Program spending summary report.

Response body schema for GET /v2/loyalties/programs/{programId}/reports/spending/summary.

data

object[]

required

Lists summary rows, one per card definition that has recorded spending. Contains at most 10 rows (max number of card definitions per program), ordered by id descending.

Show child attributes

object

string

required

Object type marker. Always report.

Allowed value: "report"

Introduction

Endpoints

Events

List program spending summary reports

Authorizations

Path Parameters

Query Parameters

Response