> ## Documentation Index
> Fetch the complete documentation index at: https://voucherify-rc-lv2-guides.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# 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](https://www.voucherify.io/contact-support) or your Technical Account Manager.
Returns total points-spending statistics for the program (all time), optionally
filtered by card definition.
## OpenAPI
````yaml /openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/spending/summary
openapi: 3.1.0
info:
title: Voucherify Loyalty v2 API
version: 2.0.0
description: >-
Complete OpenAPI specification for the Voucherify Loyalty v2 API.
All endpoints require the LOYALTY_V2 feature flag.
Combined from per-domain specs: programs.yaml, members.yaml,
program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
- url: '{protocol}://{host}'
variables:
protocol:
default: https
enum:
- https
- http
host:
default: api.voucherify.io
security:
- X-App-Id: []
X-App-Token: []
- bearerAuth: []
tags:
- name: Programs
description: >-
Loyalty program CRUD, lifecycle management, program-scoped resource
assignments (card definitions, earning rules, rewards, tier structures),
member management (create, list, get, activate, deactivate, delete),
membership retrieval (member + program + cards with tier progress, by
customer ID, customer source ID, or member ID), card operations (points
adjustment, pending points, expiring points, transactions), reward
purchases, and activity history.
- name: Card Definitions
description: >-
CRUD operations, lifecycle management, and activity history for card
definitions. Card definitions describe the configuration for loyalty
cards, including code generation, points expiration, earning/spending
limits, pending points, refunds, and balance settings.
- name: Earning Rules
description: >-
Manage earning rules that define how customers earn points or receive
incentives based on triggers (events, segments, custom events). Includes
CRUD, lifecycle, and activity history.
- name: Tier Structures
description: >-
CRUD operations, lifecycle management, and activity history for tier
structures. Includes nested tier definitions (create, list, update,
delete) within tier structures. Tier structures define the tiering model
for loyalty programs — how members qualify for and move between tiers.
- name: Benefits
description: >-
Manage benefit definitions (fixed points, proportional points, material,
digital). Includes CRUD, lifecycle transitions, and activity history.
- name: Rewards
description: >-
CRUD, lifecycle operations, and activity history for reward definitions.
Rewards can be material (product/SKU) or digital (discount coupons, gift
vouchers).
- name: Examine
description: >-
Evaluation endpoints that estimate earning opportunities and reward
availability for a customer across their loyalty program memberships,
without side effects.
paths:
/v2/loyalties/programs/{programId}/reports/spending/summary:
get:
tags:
- Programs
summary: Get program spending summary report
description: >-
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](https://www.voucherify.io/contact-support)
or your Technical Account Manager.
Returns total points-spending statistics for the program (all time),
optionally
filtered by card definition.
operationId: getProgramSpendingSummaryReport
parameters:
- name: programId
in: path
required: true
description: >-
Unique loyalty program identifier (format: `lprg_` followed by
hexadecimal characters).
schema:
type: string
- name: filters
in: query
required: false
style: deepObject
explode: true
description: >-
Field filters, e.g.
`filters[card_definition_id][conditions][$is]=lcdef_...`. Each field
accepts a `conditions` object with condition operators.
schema:
$ref: '#/components/schemas/SpendingReportListFilters'
responses:
'200':
description: Program spending summary report.
content:
application/json:
schema:
$ref: '#/components/schemas/SpendingReportSummaryResponse'
'400':
description: >-
Validation error - request body or query parameters failed
validation, or the operation is not allowed in the current resource
state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
description: Conflict - e.g. duplicate resource or invalid state transition.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
SpendingReportListFilters:
type: object
description: Filters for spending reports.
properties:
junction:
description: >-
Logical junction between the field filters. Defaults to AND
behavior.
oneOf:
- type: string
enum:
- AND
- OR
- type: 'null'
card_definition_id:
description: Filter by card definition id.
oneOf:
- $ref: >-
#/components/schemas/SpendingReportFilterCardDefinitionIdConditions
- type: 'null'
additionalProperties: false
SpendingReportSummaryResponse:
type: object
description: Program spending summary report result.
properties:
data:
type: array
description: Report entries, one per card definition.
items:
$ref: '#/components/schemas/SpendingReportSummaryEntry'
object:
type: string
const: report
description: Object type marker. Always `report`.
ErrorResponse:
type: object
description: Standard error response returned by all Loyalty v2 endpoints.
properties:
code:
type: integer
description: HTTP status code of the error.
key:
type: string
description: Machine-readable error key.
message:
type: string
description: Human-readable error message.
details:
type: string
description: Additional details about the error.
request_id:
type: string
description: Unique identifier of the request that produced the error.
resource_id:
type: string
description: Unique identifier of the resource that produced the error.
resource_type:
type: string
description: Type of the resource that produced the error.
SpendingReportFilterCardDefinitionIdConditions:
type: object
description: >-
ID filter conditions for card definition ids. Values must match pattern
`^lcdef_[a-f0-9]+$`. `$is`/`$is_not` accept a single value (string or
1-element array); `$in`/`$not_in` accept a string or an array of 1-100
values.
properties:
conditions:
type: object
minProperties: 1
additionalProperties: false
properties:
$is:
description: Matches rows whose card definition id equals the given value.
oneOf:
- type: string
pattern: ^lcdef_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lcdef_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$is_not:
description: >-
Matches rows whose card definition id does not equal the given
value.
oneOf:
- type: string
pattern: ^lcdef_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lcdef_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$in:
description: >-
Matches rows whose card definition id is one of the given
values.
oneOf:
- type: string
pattern: ^lcdef_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lcdef_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
$not_in:
description: >-
Matches rows whose card definition id is not one of the given
values.
oneOf:
- type: string
pattern: ^lcdef_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lcdef_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
required:
- conditions
additionalProperties: false
SpendingReportSummaryEntry:
type: object
description: >-
Total program spending statistics for one card definition. All numeric
fields default to 0.
properties:
id:
type: string
description: Unique identifier of the summary row.
card_definition_id:
type: string
description: Unique identifier of the card definition (format `lcdef_...`).
success:
type: number
description: Total number of successful spending operations.
success_on_reward:
type: number
description: Total number of successful reward purchases.
success_on_order:
type: number
description: Total number of successful order payments.
points:
type: number
description: Total points spent.
points_on_rewards:
type: number
description: Total points spent on reward purchases.
points_on_order:
type: number
description: Total points spent on order payments.
amount_on_order:
type: number
description: Total order amount paid with points.
object:
type: string
const: spending_summary_report
description: Object type marker. Always `spending_summary_report`.
securitySchemes:
X-App-Id:
type: apiKey
name: X-App-Id
in: header
X-App-Token:
type: apiKey
name: X-App-Token
in: header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````