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.

Billing: Read (free unless it says otherwise) · Rate limit: 120/min

get/v1/messaging/analytics/inbox/heatmap

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/analytics/inbox/heatmap
  • Auth: HTTP bearer

Query parameters

action'message.received' | 'message.sent' | 'message.read' | 'all'

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

sourcestring
toDatestring date
fromDatestring date required
platformstring
accountIdstring

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.