Inbox Analytics

Get day × hour heatmap

Day-of-week × hour-of-day breakdown of inbox messages. Buckets are sparse — only cells with at least one event are returned; clients zero-fill the rest to render the full 7×24 grid. The dow field follows ClickHouse's toDayOfWeek convention (1 = Monday … 7 = Sunday). Max date range is 365 days.

get/v1/analytics/inbox/heatmap

Query parameters

fromDatestring date required
toDatestring date
profileIdstring
platformstring
accountIdstring
sourcestring
action'message.received' | 'message.sent' | 'message.read' | 'all'

Narrow to a single event type. "all" or omitted means no filter.

Response

Heatmap buckets

successboolean
fromstring date
tostring date nullable

Changes

No recorded changes to this endpoint across all 27 revisions of this API.