v1Ressources/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/topicsCorps de la requête
clientIdstringobligatoire
The client (business) this concerns.
namestringobligatoire
The topic's name, up to 80 characters.
descriptionstringfacultatif
An optional note, up to 255 characters.
kindstring (brand | competitor | product | industry | campaign | custom)obligatoire
What the topic is about. A competitor topic also needs competitorId.
competitorIdstringfacultatif
The competitor a competitor topic follows.
queryobjectobligatoire
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 stringobligatoire
The networks to follow: x, reddit, bluesky, tiktok, instagram, facebook, youtube, news, web, reviews.
languagesarray of stringfacultatif
Up to five two-letter language codes. Empty means any language.
Réponse
dataobjectfacultatif
topicobjectfacultatif
The topic that was created.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/listening/topics
Votre clé API
Corps de la requête*
{}