v1Resources/Social Listening/getRead the insights workspace
Read the insights workspace
Requires an active agency user with Listening access and access to the client. Reads stored data only; never starts collection or AI generation. Dates are inclusive UTC days (YYYY-MM-DD), at most 400 days; omitted dates default to seven days ending yesterday. Array query parameters are comma-separated. compare=false disables the previous-period comparison. segment selects public posts, owned channels or both (all, the default). Brand insights always apply the brand entity scope. Post previews are limited to 500 characters; cursor is a nonnegative offset and must be reused with unchanged filters. Saved workspace findings retain their own evidence windows. Missing measurements remain unavailable.
get
listening:read/api/v1/listening/insights/briefingQuery parameters
clientIdstringrequired
fromstringoptional
tostringoptional
comparebooleanoptional
segmentstring (public | owned | all)optional
topicIdsarray of stringoptional
entitiesarray of stringoptional
themeIdsarray of stringoptional
tagIdsarray of stringoptional
sourcesarray of string (x | reddit | bluesky | tiktok | instagram | facebook | youtube | news | web | reviews)optional
sentimentarray of string (positive | neutral | negative)optional
languagesarray of stringoptional
messageTypesarray of stringoptional
contentTypesarray of stringoptional
includeSpambooleanoptional
unclassifiedbooleanoptional
qstringoptional
excludearray of stringoptional
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The listening data could not be read.
get/api/v1/listening/insights/briefing
Your API key
clientId *
from
to
compare
segment
topicIds
entities
themeIds
tagIds
sources
sentiment
languages
messageTypes
contentTypes
includeSpam
unclassified
q
exclude
{}