v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Inbox Analytics

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.

get/v1/analytics/inbox/volume

Query parameters

fromDatestring date required

Inclusive lower bound (YYYY-MM-DD). Required.

toDatestring date

Inclusive upper bound (YYYY-MM-DD). Defaults to today.

profileIdstring
platformstring

Filter by single platform (facebook, instagram, twitter, etc.).

accountIdstring
sourcestring

Filter by metadata.source lineage (human, workflow, sequence, broadcast, comment_automation, api, contact, platform).

Response

Volume breakdown

successboolean
fromstring date
tostring date nullable