A valid request URL is required to generate request examples{
"data": [
{
"date": "2023-12-25",
"earning_rule_id": "<string>",
"earning_item_id": "<string>",
"card_definition_id": "<string>",
"success_count": 123,
"points": 123,
"pending_points": 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>"
}Get program points-earnings daily report
This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.
Returns aggregated daily points-earnings statistics for the program over the given date range and resolution, optionally filtered by earning rule and card definition.
The date range is limited per resolution:
maximum 90 days for day, 12 weeks for week, 12 months for month, 4 quarters for quarter.
curl --request GET \
--url {protocol}://{host}/v2/loyalties/programs/{programId}/reports/points-earnings/daily \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"date": "2023-12-25",
"earning_rule_id": "<string>",
"earning_item_id": "<string>",
"card_definition_id": "<string>",
"success_count": 123,
"points": 123,
"pending_points": 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>"
}Authorizations
Path Parameters
Unique loyalty program identifier (format: lprg_ followed by hexadecimal characters).
^lprg_[a-f0-9]+$Query Parameters
Start of the report date range (inclusive), in YYYY-MM-DD format.
^\d{4}-\d{2}-\d{2}$End of the report date range, in YYYY-MM-DD format. Must be after start_date.
^\d{4}-\d{2}-\d{2}$Aggregation resolution of the report. The allowed date range depends on the resolution: day — max 90 days, week — max 12 weeks, month — max 12 months, quarter — max 4 quarters.
day, week, month, quarter Field filters. Each field accepts a conditions object with condition operators.
Filters for program points-earnings reports.
Show child attributes
Show child attributes
Was this page helpful?