Skip to main content
GET
/
v2
/
loyalties
/
programs
/
{programId}
/
reports
/
spending
/
summary
Error
A valid request URL is required to generate request examples
{
  "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>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
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.

Response

Program spending summary report.

Program spending summary report result.

​
data
object[]

Report entries, one per card definition.

​
object
string

Object type marker. Always report.

Allowed value: "report"
Last modified on July 9, 2026