v1Recursos/Social Listening/getLer a participação na conversa
Ler a participação na conversa
Requer um usuário ativo da agência com acesso a Escuta e ao cliente. Lê apenas publicações públicas salvas; canais próprios são excluídos mesmo quando solicitados. As datas são dias UTC inclusivos, até 400 dias; por padrão, sete dias terminando ontem. Filtros de lista são separados por vírgulas. A percepção requer entity=brand ou um ID de concorrente monitorado; entidades desconhecidas retornam 404. O intervalo de participação é hour, day ou week (day por padrão). Sem coleta nem geração por IA.
get
listening:read/api/v1/listening/competitive/share-of-voiceParâmetros de consulta
clientIdstringobrigatório
fromstringopcional
tostringopcional
comparebooleanopcional
segmentstring (public | owned | all)opcional
topicIdsarray of stringopcional
entitiesarray of stringopcional
themeIdsarray of stringopcional
tagIdsarray of stringopcional
sourcesarray of string (x | reddit | bluesky | tiktok | instagram | facebook | youtube | news | web | reviews)opcional
sentimentarray of string (positive | neutral | negative)opcional
languagesarray of stringopcional
messageTypesarray of stringopcional
contentTypesarray of stringopcional
includeSpambooleanopcional
unclassifiedbooleanopcional
qstringopcional
excludearray of stringopcional
intervalstring (hour | day | week)opcional
Resposta
dataobjectopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503Não foi possível ler os dados competitivos.
get/api/v1/listening/competitive/share-of-voice
Sua chave de API
clientId *
from
to
compare
segment
topicIds
entities
themeIds
tagIds
sources
sentiment
languages
messageTypes
contentTypes
includeSpam
unclassified
q
exclude
interval
{}