Synup
Criar chave
v1Recursos/Reviews/getListar concorrentes rastreados

Listar concorrentes rastreados

Os concorrentes rastreados para um local, ou — com clientId sem locationId — o conjunto consolidado em nível de cliente, exibido em todos os seus locais.

get/api/v1/reviews/competitors
reviews:read
Parâmetros de consulta
locationIdstringopcional
O local a consultar. Omita para listar em vez disso o conjunto consolidado em nível de cliente — envie clientId nesse caso.
clientIdstringopcional
O cliente do local. Obrigatório junto com locationId; sozinho, lista o conjunto consolidado em nível de cliente.
Resposta
dataobjectopcional
competitorsarray of objectopcional
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/reviews/competitors
Sua chave de API
locationId
clientId
{
  "data": {
    "competitors": [
      {
        "id": "cm_comp_1",
        "kind": "competitor",
        "source": "manual",
        "name": "Smile Bright Dental",
        "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
        "address": "45 Congress Ave, Austin, TX",
        "lastUpdated": "2026-02-01T06:00:00.000Z",
        "avgRating": 4.6,
        "reviewCount": 340
      }
    ]
  }
}

Guias que usam este recurso