Rewrd API
  1. Merchant
Rewrd API
  • Customers
    • Create or Update a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • Update a Customer
      PUT
    • Restrict a Customer
      PATCH
    • Unrestrict a Customer
      PATCH
  • Merchant
    • Get Merchant Configuration
      GET
    • Update Merchant Configuration
      PATCH
    • List Earning Rules
      GET
    • Get Earning Rule Details
      GET
    • Get IP Whitelist
      GET
    • Update IP Whitelist
      PUT
    • Get Merchant Analytics
      GET
  • Points
    • Credit Points to a Customer
      POST
    • Redeem Points
      POST
    • Get Customer Transaction History
      GET
  1. Merchant

Get Merchant Analytics

GET
/merchant/analytics
Retrieves aggregated analytics for your loyalty program, filtered by time period.
The summary includes total points earned and redeemed, number of active customers, combined points balance, and total transaction count for the specified period.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Responses

🟢200OK
application/json
Analytics retrieved successfully.
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/merchant/analytics?period=30d' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Analytics retrieved successfully",
    "data": {
        "period": "30d",
        "total_earned": 25000,
        "total_redeemed": 8500,
        "active_customers": 142,
        "total_points_balance": 175000,
        "total_transactions": 854
    }
}
Modified at 2026-02-25 12:17:15
Previous
Update IP Whitelist
Next
Credit Points to a Customer
Built with