Sign in
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

Changed in 3 of the 56 revisions of this API.7

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3e6ddf2a99ea1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d752See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added