v1Resources/Social Inbox/getRead inbox activity report
Read inbox activity report
Requires an active agency user with Social access and Social Inbox enabled. User visibility and credential client restrictions are intersected. Optional clientId accepts native/public IDs; locations is a comma-separated list of native/public/legacy IDs, resolved to native IDs. Supply both valid from/to dates no more than 366 days apart, or omit both for the last 30 days. Both calendar days are included using tz, minutes east of UTC (-840 to 840, default 0). Returns received/actioned statistics, prior-period comparison, day/hour breakdowns and time-to-action. Null means unavailable; truncated:true discloses the collection cap. Uses saved data only.
get
inbox:read/api/v1/inbox/reportQuery parameters
clientIdstringoptional
locationsarray of stringoptional
fromstringoptional
tostringoptional
tzintegeroptional
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The requested change conflicts with the current record.
413More than 2000 items match or belong to expanded threads; narrow the selection.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The inbox operation could not be completed.
get/api/v1/inbox/report
Your API key
clientId
locations
from
to
tz
{}