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 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
/v1/analytics/inbox/conversations/{conversationId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

conversationId*string

Mongo _id or platformConversationId.

Query Parameters

fromDate*string
Formatdate
toDate?string
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

{  "success": true,  "conversationId": "string",  "mongoId": "string",  "platform": "string",  "from": "2019-08-24",  "to": "2019-08-24",  "summary": {    "received": 0,    "sent": 0,    "read": 0,    "failed": 0,    "totalMessages": 0,    "firstMessageAt": "2019-08-24T14:15:22Z",    "lastMessageAt": "2019-08-24T14:15:22Z"  },  "timeseries": [    {      "date": "2019-08-24",      "sent": 0,      "received": 0,      "read": 0,      "failed": 0    }  ],  "bySource": [    {      "source": "string",      "count": 0    }  ]}
Was this page helpful?

List conversation analytics

Per-conversation listing with per-row totals + first/last message timestamps. The inbox analog of GET /v1/analytics (posts listing): same filter shape, same pagination, same sort/order semantics. Use as the entry point for the per-conversation analytics drawer at /v1/analytics/inbox/conversations/{conversationId}. Rows are enriched with the conversation's participant info (`participantName`, `participantUsername`, `participantPicture`) and last-message preview by joining the Conversation document scoped to the caller's team. Max date range is 365 days.

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.