Synup
Criar chave
v1Recursos/Reviews/getObter um resumo de análise de avaliações

Obter um resumo de análise de avaliações

Análise de avaliações agregada nos locais deste cliente (ou de toda a agência): contagem, avaliação média, distribuição de avaliações, mix de sentimento, taxa de resposta, detalhamento por plataforma e uma tendência mensal. Limite o escopo com tags.

get/api/v1/reviews/analytics/summary
reviews:read
Parâmetros de consulta
clientIdstringopcional
Limitar aos locais de um cliente.
tagsstringopcional
Nomes de tags de local separados por vírgula — apenas locais com pelo menos uma dessas tags são incluídos.
monthsintegeropcional
Duração da tendência em meses. Padrão 6.
Resposta
dataobjectopcional
locationsnumberopcional
Número de locais no escopo.
countnumberopcional
Total de avaliações no escopo.
avgRatingnumberopcional
Avaliação média no escopo.
distributionobjectopcional
Contagem de avaliações por classificação em estrelas (1-5).
sentimentobjectopcional
Contagem de avaliações por sentimento.
positivenumberopcional
neutralnumberopcional
negativenumberopcional
responseRatenumberopcional
Percentual de avaliações com resposta.
byPlatformarray of objectopcional
Contagem e avaliação média por plataforma.
platformstringopcional
countnumberopcional
avgRatingnumberopcional
trendarray of objectopcional
Contagem mensal e avaliação média.
monthstringopcional
countnumberopcional
avgRatingnumberopcional
Erros
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/reviews/analytics/summary
Sua chave de API
clientId
tags
months
{
  "data": {
    "locations": 5,
    "count": 210,
    "avgRating": 4.4,
    "distribution": {
      "1": 4,
      "2": 8,
      "3": 12,
      "4": 60,
      "5": 126
    },
    "sentiment": {
      "positive": 172,
      "neutral": 24,
      "negative": 14
    },
    "responseRate": 91,
    "byPlatform": [
      {
        "platform": "google",
        "label": "Google",
        "count": 160,
        "avgRating": 4.5
      }
    ],
    "trend": [
      {
        "month": "2026-02",
        "count": 114,
        "avgRating": 4.4
      }
    ]
  }
}

Guias que usam este recurso