Synup
Criar chave
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
clientIdstringobrigatório
The client (business) this concerns. Required.
Resposta
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.
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.
get/api/v1/listening/setup
Sua chave 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"
    ]
  }
}

Novo na API da Synup?