v1Resources/Social Listening/getRead competitive aspect comparisons
Read competitive aspect comparisons
Requires an active agency user with Listening access and client access. Reads stored public posts only; owned channels are excluded even if requested. Dates are inclusive UTC days, up to 400 days; defaults to seven days ending yesterday. Array filters are comma-separated. Perception requires entity=brand or a tracked competitor ID; unknown entities return 404. Share-of-voice interval is hour, day or week (default day). No collection or AI generation.
get
listening:read/api/v1/listening/competitive/aspectsQuery 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 competitive data could not be read.
get/api/v1/listening/competitive/aspects
Your API key
clientId *
from
to
compare
segment
topicIds
entities
themeIds
tagIds
sources
sentiment
languages
messageTypes
contentTypes
includeSpam
unclassified
q
exclude
{}