Synup
Crear clave
v1Recursos/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/api/v1/listening/setup
listening:read
Parámetros de consulta
clientIdstringobligatorio
The client (business) this concerns. Required.
Respuesta
dataobjectopcional
clientobjectopcional
The client: id and name.
topicsarray of objectopcional
The client's topics, including suggestions that are not turned on yet.
competitorsarray of objectopcional
The competitors the client tracks.
scheduleobjectopcional
How often results update (monthly) and when the next update is due.
topicKindsarray of stringopcional
The topic kinds a topic can have.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/listening/setup
Su clave de 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"
    ]
  }
}

¿Nuevo en la API de Synup?