Loyalty Program Analytics

GET

https://api.zid.sa/v1/managers/loyalty-program/analytics

Returns analytics data for the store's loyalty program within a specified date range, including earned, redeemed, and pending points, as well as customer and redemption counts.

🔑Scopes

third_loyalty_read - Third Loyalty Read

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zid.sa/v1/managers/loyalty-program/analytics?date_from=2026-01-01&date_to=2026-01-31' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-ID: {{StoreId}}'

Response Example

200 - Example 1

{
    "total_earned_points": 0,
    "total_redeemed_points": 0,
    "total_pending_points": 0,
    "total_customers_with_points": 0,
    "total_customers": 0,
    "total_customers_with_redeemed_points": 0,
    "total_redemption_count": 0
}

Modified at 2026-08-24 08:36:04

Adjust Customer Points

Loyalty Program Settings