Skip to content

Cards by type​

GET
/analytics/card-type-distribution

How the shop’s cards split across the card types it runs. Card-derived. 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​

Cards by type

application/json
JSON
{
  
"distribution": [
  
  
{
  
  
  
"type": "standard",
  
  
  
"count": 12,
  
  
  
"label_key": "card_types.standard",
  
  
  
"color": "#6F4E37"
  
  
}
  
]
}

Samples​

Powered by VitePress OpenAPI

Requires the Business API add-on.