Skip to content

Busiest programs

GET
/analytics/top-programs

Transaction-derived: recomputed for a location-restricted key.

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)

Parameters

Query Parameters

limit*
Type
integer
Required

Responses

Busiest programs

application/json
JSON
{
  
"programs": [
  
  
{
  
  
  
"program_id": "prg_docsfixture0001",
  
  
  
"program_name": "Coffee Card",
  
  
  
"brand_color_hex": "#6F4E37",
  
  
  
"activity_count": 480
  
  
}
  
]
}

Samples

Powered by VitePress OpenAPI

Requires the Business API add-on.