v1Ressourcen/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/setupQuery-Parameter
clientIdstringerforderlich
The client (business) this concerns. Required.
Antwort
dataobjectoptional
clientobjectoptional
The client: id and name.
topicsarray of objectoptional
The client's topics, including suggestions that are not turned on yet.
competitorsarray of objectoptional
The competitors the client tracks.
scheduleobjectoptional
How often results update (monthly) and when the next update is due.
topicKindsarray of stringoptional
The topic kinds a topic can have.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/listening/setup
Ihr API-Schlüssel
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"
]
}
}