Skip to content

Headline numbers​

GET
/analytics/summary

The headline numbers, mixing card counts with till activity. Requires an UNRESTRICTED key: a key limited to specific locations is refused with 403 location_scope_unsupported, and shop-wide data is never silently served to it instead. This series is not derived from transactions, which are the only site-attributed rows in the system, so it cannot be narrowed to a location.

Authorizations​

ApiKeyBearer

A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.

Type
HTTP (bearer)

Responses​

Headline numbers

application/json
JSON
{
  
"active_locations": 3,
  
"active_programs": 4,
  
"activity_30d": 1290,
  
"new_cards_30d": 96
}

Samples​

Powered by VitePress OpenAPI

Requires the Business API add-on.