Docs

Get category heatmap report

GET /api/v1/programmatic/reports/category-heatmap

GET/api/v1/programmatic/reports/category-heatmap
Reportsv1reports:read

Returns category spending intensity over the selected period.

Parameters

NameInType Description
monthquerystringOptional 2026-07
periodquery6m | 12mOptional 6m

Code examples

curl --request GET \
  --url 'https://api.tetri.app/api/v1/programmatic/reports/category-heatmap?month=2026-07&period=6m' \
  --header 'Authorization: Bearer $TETRI_API_TOKEN'

Responses

200Category heatmap returned successfully.
401The access token is missing, invalid, expired, or revoked.
403The token does not have the required scope or workspace access.
429The credential has exceeded its request limit.