Get Wallet Analytics by Rule

GET

https://api.zid.sa/v1/customer-wallets/analytics/by-rule/

Retrieves wallet performance metrics for individual cashback rules, including usage count, customer count, total sales, and total cashback.

🔑Scopes

third_customer_wallet_read - Customer Wallet 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/customer-wallets/analytics/by-rule/?rule_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08%2C123e4567-e89b-12d3-a456-426614174000' \
--header 'Store-Id: 123456' \
--header 'X-manager-Token: {{Access-Token}}'

Response Example

200 - Example 1

{
    "results": [
        {
            "rule_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "number_of_usages": 125,
            "number_of_customers": 98,
            "total_sales": 25000.5,
            "total_cashback": 1250.25,
            "currency": "SAR"
        },
        {
            "rule_id": "123e4567-e89b-12d3-a456-426614174000",
            "number_of_usages": 75,
            "number_of_customers": 61,
            "total_sales": 12000,
            "total_cashback": 600,
            "currency": "SAR"
        }
    ]
}

Modified at 2026-09-02 10:01:01

Get Wallet Analytics

List Customer Wallets