GET/api/v2/loyalty/auto-assign/stats/{loyaltyProgramId}

Get point assignment statistics for a loyalty program

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
loyaltyProgramId (path)unknownYesThe unique identifier of the loyalty program
startDate (query)string (date-time)NoOptional start date for the analysis period
endDate (query)string (date-time)NoOptional end date for the analysis period

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
LoyaltyProgramIdunknownNo
PeriodstringNo
StartDatestring (date-time)No
EndDatestring (date-time)No
TotalAssignmentsunknownNo
TotalPointsAssignedunknownNo
TotalReversalsunknownNo
TotalPointsReversedunknownNo
AveragePointsPerTransactionunknownNo
SourceBreakdownarray of AssignmentSourceStatsResponseNo
DailyStatsarray of DailyAssignmentStatsResponseNo
GeneratedAtstring (date-time)No

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/loyalty/auto-assign/stats/{loyaltyProgramId}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.