Metrics

Get Loyalty metrics

Retrieve loyalty program metrics including points in circulation, active accounts, visits, tier distribution, and digital wallet pass installation (Google and Apple). Platform admins see all organizations; organization members see only their organization.

get/v1/admin/metrics/loyalty

Request

Base URL: https://api.prod.keyban.io
URL: https://api.prod.keyban.io/v1/admin/metrics/loyalty
Auth: X-Api-Key (a scheme the document does not define)

Query parameters

startDatestring date

Example:2026-01-01

Start date of the metrics period (inclusive, format: YYYY-MM-DD). Defaults to 30 days before endDate if omitted.

endDatestring date

Example:2026-01-31

End date of the metrics period (inclusive, format: YYYY-MM-DD). Defaults to today if omitted.

applicationIdstring uuid

Optional application UUID to scope metrics to a single application

Response

Loyalty metrics retrieved successfully

organizationIdstring uuid required

Organization UUID

organizationNamestring required

Organization display name

Example response

[
  {
    "applications": [
      {
        "metrics": {
          "pointsInCirculation": "1250000",
          "pointsBurned": "150000",
          "netCirculation": "1100000",
          "activeAccounts": 214,
          "totalVisits": 873,
          "tierDistribution": [
            {
              "tierName": "Gold",
              "requiredVisits": 15,
              "accountCount": 48
            }
          ],
          "walletInstallation": {
            "googleInstalled": 1287,
            "googlePercentage": 52.5,
            "appleInstalled": 934,
            "applePercentage": 38.1,
            "combinedInstalled": 2021,
            "combinedPercentage": 82.5,
            "totalAccounts": 2450
          }
        }
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.