1. Merchant
Rewrd API
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • 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
    • List Merchant IPs
      GET
    • Add Merchant IP
      POST
    • Update Merchant IP
      PATCH
    • Delete Merchant IP
      DELETE
    • Get Merchant Analytics
      GET
  • Points
    • Process a Unified Points Transaction
      POST
    • Get Customer Transaction History
      GET
  1. Merchant

Get Merchant Analytics

Development Server
https://rewrd-api-staging.fly.dev/v1
Development Server
https://rewrd-api-staging.fly.dev/v1
GET
/merchant/analytics
Retrieves aggregated analytics for your loyalty program, filtered by time period.
What each metric means:
MetricWhat it tells you
total_earnedTotal points given out to customers — higher means more customer engagement
total_redeemedTotal points spent by customers — higher means customers find your rewards valuable
active_customersCustomers who earned or redeemed at least once in the period — your "active base"
total_points_balanceCombined unspent points across all customers — this is your outstanding liability
total_transactionsTotal number of credit + debit operations — measures overall program activity
Use the period parameter to compare performance across different time windows (today, 7 days, 30 days, or all time).

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 'https://rewrd-api-staging.fly.dev/v1/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-04-07 21:05:20
Previous
Delete Merchant IP
Next
Process a Unified Points Transaction
Built with