Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Merchants

Get Merchant Metrics

Get metrics for a merchant's loyalty program.

Args:

  • merchant_id: The ID of the merchant (program)
  • period: The time period for metrics (7d, 30d, 90d, custom)
  • user: The authenticated user

Returns:

  • MetricsResponse with program metrics and trends
get/v2/merchants/{merchant_id}/metrics

Path parameters

merchant_idstring required

Query parameters

periodstring

Headers

authorizationstring nullable

Response

Successful Response

activeMembersinteger required
redemptionsinteger required
engagementRatenumber required
pointsIssuedinteger required
currencyEquivalentnumber required