H!HOPPA
GET/api/v2/loyalty/geographic-analytics

Get geographic analytics with regional performance data

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
period (query)stringNoAnalysis period (e.g., "30d", "90d", "1y")

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
RegionStatsarray of RegionStatsResponseNo
PeriodstringNo
GeneratedAtstring (date-time)No

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/loyalty/geographic-analytics" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.