GET
/api/v2/loyalty/location-insightsGet location insights with city and country performance rankings
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| period (query) | string | No | Analysis period (e.g., "30d", "90d", "1y") |
| metric (query) | string | No | Metric to analyze (e.g., "transactions", "users", "points") |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| TopLocations | array of LocationStatsResponse | No | |
| Period | string | No | |
| Metric | string | No | |
| GeneratedAt | string (date-time) | No |
401 — Unauthorized
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/loyalty/location-insights" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.