A program's activity timeline

GET

/programs/{id}/timeline

Cards issued and stamps awarded per bucket over a range, grouped by day, week or month. buckets is the label axis and the series are index-aligned with it, zero-filled, so it can be charted without reindexing. stamps is null — not an array of zeros — for faced programs (discount, access, prepaid, points), which have no stamps at all. Very long ranges at day granularity are refused rather than truncated.

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

Path Parameters

id*

An opaque id. The API never promises an id format.

Type

string

Required

Responses

A program's activity timeline

Content-Type

application/json

{

  

"group": "day",

  

"from": "2026-08-05",

  

"to": "2026-09-04",

  

"buckets": [

  

  

"2026-09-04"

  

],

  

"cards": [

  

  

37

  

],

  

"stamps": [

  

  

96

  

]

}

GET

/programs/{id}/timeline

Samples

Powered by VitePress OpenAPI