Get Dashboard Metrics

Get dashboard metrics as JSON

Returns complete dashboard data including:

  • Period information
  • Visits metrics
  • Customer metrics (loyal vs new)
  • Referral metrics
  • Loyalty ROI
  • Transaction metrics
  • Retention metrics

Integration access is restricted to the credential's location. Pagination, monetary units and response envelopes are endpoint-specific; use the schema below. Do not assume that POST/PATCH requests are safe to retry after a timeout.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to month
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json