Get program spending summary report

BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may be subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Returns total points-spending statistics for the program (all time), optionally filtered by card definition.

GET /v2/loyalties/programs/{programId}/reports/spending/summary

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {
      "id": "<string>",
      "card_definition_id": "<string>",
      "success": 123,
      "success_on_reward": 123,
      "success_on_order": 123,
      "points": 123,
      "points_on_rewards": 123,
      "points_on_order": 123,
      "amount_on_order": 123,
      "object": "<string>"
    }
  ],
  "object": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Unique loyalty program identifier (format: lprg_ followed by hexadecimal characters).

Query Parameters

filters · object

Field filters, e.g. filters[card_definition_id][conditions][$is]=lcdef_.... Each field accepts a conditions object with condition operators. Filters for spending reports.

Show child attributes

Response

200

application/json

Program spending summary report.

Program spending summary report result.

data · object[]

Report entries, one per card definition.

Show child attributes

object · string

Object type marker. Always report.

Allowed value: "report"