v1Recursos/Social Listening/postCreate a listening topic
Create a listening topic
Creates a topic as a suggestion. It collects nothing until you turn it on with a PATCH that sets status to active.
post
listening:write/api/v1/listening/topicsCorpo da solicitação
clientIdstringobrigatório
The client (business) this concerns.
namestringobrigatório
The topic's name, up to 80 characters.
descriptionstringopcional
An optional note, up to 255 characters.
kindstring (brand | competitor | product | industry | campaign | custom)obrigatório
What the topic is about. A competitor topic also needs competitorId.
competitorIdstringopcional
The competitor a competitor topic follows.
queryobjectobrigatório
What to find. include is a list of alternatives (OR); each alternative is a list of term groups (AND), and a term group is { match: "all" | "any", terms: [...] }. Optional exclude lists terms that rule a post out, and fromHandles names accounts to watch by network.
sourcesarray of stringobrigatório
The networks to follow: x, reddit, bluesky, tiktok, instagram, facebook, youtube, news, web, reviews.
languagesarray of stringopcional
Up to five two-letter language codes. Empty means any language.
Resposta
dataobjectopcional
topicobjectopcional
The topic that was created.
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.
post/api/v1/listening/topics
Sua chave de API
Corpo da solicitação*
{}