v1Ressources/Social Listening/getGet a client's listening setup
Get a client's listening setup
Returns what a client tracks in social listening — its topics and competitors — and when results next update. Results update once a month.
get
listening:read/api/v1/listening/setupParamètres de requête
clientIdstringobligatoire
The client (business) this concerns. Required.
Réponse
dataobjectfacultatif
clientobjectfacultatif
The client: id and name.
topicsarray of objectfacultatif
The client's topics, including suggestions that are not turned on yet.
competitorsarray of objectfacultatif
The competitors the client tracks.
scheduleobjectfacultatif
How often results update (monthly) and when the next update is due.
topicKindsarray of stringfacultatif
The topic kinds a topic can have.
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.
get/api/v1/listening/setup
Votre clé API
clientId *
{
"data": {
"client": {
"id": "cli_123",
"name": "Acme Dental"
},
"topics": [
{
"id": "top_123",
"name": "Acme Dental",
"kind": "brand",
"status": "active",
"sources": [
"x",
"reddit"
],
"languages": []
}
],
"competitors": [
{
"id": "cmp_123",
"name": "Bright Smiles",
"aliases": [],
"handles": {
"x": [
"brightsmiles"
]
},
"website": null,
"status": "active"
}
],
"schedule": {
"frequency": "monthly",
"nextUpdate": "2026-11-01T00:00:00.000Z"
},
"topicKinds": [
"brand",
"competitor",
"product",
"industry",
"campaign",
"custom"
]
}
}