Skip to content

Stamps over time

GET
/analytics/stamps-timeline

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

from*
Type
string
Required
to*
Type
string
Required
group*
Type
string
Required
Valid values
"day""week""month"
program_ids*
Required

Responses

Stamps over time

application/json
JSON
{
  
"group": "day",
  
"from": "2026-08-05",
  
"to": "2026-09-04",
  
"buckets": [
  
  
"2026-09-04"
  
],
  
"series": [
  
  
{
  
  
  
"program_id": "prg_docsfixture0001",
  
  
  
"program_name": "Coffee Card",
  
  
  
"brand_color_hex": "#6F4E37",
  
  
  
"data": [
  
  
  
  
96
  
  
  
]
  
  
}
  
]
}

Samples

Powered by VitePress OpenAPI

Requires the Business API add-on.