Zernio
Zernio
API Reference

Inbox Analytics

List conversation analyticsGETGet conversation analyticsGETGet day × hour heatmapGETGet inbox response-time statsGETGet inbox source breakdownGETGet top accounts by inbox volumeGETGet inbox messaging volumeGET
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
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

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Query Parameters

fromDate*string
Formatdate
toDate?string
Formatdate
profileId?string
platform?string
accountId?string
source?string
action?string

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

Value in

  • "message.received"
  • "message.sent"
  • "message.read"
  • "all"

Response Body

application/json

application/json

application/json

application/json

{  "success": true,  "from": "2019-08-24",  "to": "2019-08-24",  "buckets": [    {      "dow": 1,      "hour": 0,      "received": 0,      "sent": 0,      "read": 0    }  ]}
Was this page helpful?

Get conversation analytics

Per-conversation inbox analytics. The inbox analog of /v1/analytics/post-timeline — one conversation, daily totals, source mix. The {conversationId} path param accepts EITHER the Mongo `_id` of the Conversation document OR its `platformConversationId` (the same identity used by metadata.conversationId at ingest time). Ownership is verified in MongoDB against the caller's team before the Tinybird query fires. Max date range is 365 days.

Get inbox response-time stats

Time-to-first-response stats. Pairs each received message with the next sent message in the same conversation and reports the delta as both summary statistics and a fixed-bucket histogram suited for the analytics page's TTR chart. `sampleSize` reflects only conversations that received AND got a reply in the window — received-but-never-answered conversations are excluded. Compare against /v1/analytics/inbox/volume's `summary.received` to compute reply rate. Max date range is 365 days.