Inbox Analytics

Get day × hour heatmap

Changed on

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

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/analytics/inbox/heatmap
  • Auth: HTTP bearer

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

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status