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 top accounts by inbox volume

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

GET
/v1/analytics/inbox/top-accounts

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
source?string
limit?integer

Cap on returned rows. Lower than the posting listing's 100 because each row triggers a SocialAccount Mongo lookup.

Range1 <= value <= 50
Default10

Response Body

application/json

application/json

application/json

application/json

{  "success": true,  "from": "2019-08-24",  "to": "2019-08-24",  "accounts": [    {      "accountId": "string",      "platform": "string",      "displayName": "string",      "username": "string",      "received": 0,      "sent": 0,      "total": 0,      "conversations": 0,      "medianResponseSeconds": 0,      "repliedCount": 0    }  ]}
Was this page helpful?

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 inbox messaging volume

Daily inbox messaging volume + breakdowns. Folds the raw messaging events into three projections so the client can render the volume chart, KPI strip, and per-platform stacked bar from a single call. Max date range is 365 days.