Zernio
APIFor you
Zernio
APIFor you
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
OverviewPlatformsAPI ReferenceResources
Inbox Analytics

Get inbox source breakdown

Breakdown of inbox messages by their lineage source (the metadata.source field set at ingest time: human / workflow / sequence / broadcast / comment_automation / api / contact / platform). Each source row also carries a per-platform sub-split. Max date range is 365 days.

GET
/v1/analytics/inbox/source-breakdown

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

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

Response Body

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.inboxanalytics.getInboxSourceBreakdown({  query: {    fromDate: '2026-01-15',  },});console.log(data);
{  "success": true,  "from": "2019-08-24",  "to": "2019-08-24",  "sources": [    {      "source": "string",      "received": 0,      "sent": 0,      "read": 0,      "byPlatform": [        {          "platform": "string",          "received": 0,          "sent": 0,          "read": 0        }      ]    }  ]}
Was this page helpful?

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.

Get top accounts by inbox volume

Leaderboard of accounts by inbox message volume. Decorates each row with display labels from the live SocialAccount record (so the UI shows username + displayName, not only an ID). Accounts that no longer map to a SocialAccount surface as "(disconnected)" so the row stays visible. Max date range is 365 days.