Synupv1
Criar chave
v1Recursos/Clients/getObter resumo do cliente

Obter resumo do cliente

Retorna um retrato consolidado de um cliente: estatísticas agregadas de localizações, avaliações e SEO.

get/api/v1/clients/summary
clients:read
Parâmetros de consulta
clientIdstringobrigatório
O cliente a resumir.
Resposta
dataobjectopcional
locationsobjectopcional
Estatísticas agregadas de localizações deste cliente.
reviewsobjectopcional
Estatísticas agregadas de avaliações deste cliente.
seoobjectopcional
Estatísticas agregadas de ranking de SEO deste cliente.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/clients/summary
Sua chave de API
clientId *
{
  "data": {
    "locations": {
      "total": 1,
      "byStatus": {
        "approved": 1
      },
      "byVerification": {
        "unknown": 1
      }
    },
    "reviews": {
      "avgRating": 4.8,
      "total": 26
    },
    "seo": {
      "avgRank": 3.2,
      "top3Pct": 0.62
    }
  }
}