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

Obter análise de avaliações

KPIs (com variações período a período), uma tendência mensal (volume, avaliação, mix de sentimento, taxa de resposta), distribuição de avaliações, detalhamento por plataforma, horários por dia da semana, um benchmark da agência, temas e um resumo de IA — para um local.

get/api/v1/reviews/analytics
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
O local a consultar.
clientIdstringobrigatório
O cliente do local.
kpiDaysinteger (7 | 30 | 90)opcional
Janela de KPI em dias: 7, 30 ou 90. Padrão 30.
trendMonthsinteger (3 | 6 | 12)opcional
Duração da tendência em meses: 3, 6 ou 12. Padrão 6.
Resposta
dataobjectopcional
O payload completo de Análise de Avaliações.
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/analytics
Sua chave de API
locationId *
clientId *
kpiDays
trendMonths
{
  "data": {
    "total": 210,
    "kpis": {
      "totalReviews": {
        "value": 210,
        "delta": 14
      },
      "avgRating": {
        "value": 4.4,
        "delta": 0.1
      },
      "responseRate": {
        "value": 91,
        "delta": 3
      },
      "newReviews": {
        "value": 14,
        "delta": 3
      }
    },
    "spark": {
      "counts": [
        1,
        2,
        0,
        3,
        1,
        2
      ],
      "ratings": [
        4,
        5,
        0,
        4,
        5,
        4
      ],
      "response": [
        1,
        2,
        0,
        3,
        1,
        2
      ]
    },
    "trend": {
      "months": [
        "2026-01",
        "2026-02"
      ],
      "count": [
        96,
        114
      ],
      "avgRating": [
        4.3,
        4.4
      ],
      "positive": [
        78,
        92
      ],
      "neutral": [
        12,
        14
      ],
      "negative": [
        6,
        8
      ],
      "responseRate": [
        88,
        91
      ]
    },
    "distribution": [
      4,
      8,
      12,
      60,
      126
    ],
    "byPlatform": [
      {
        "platform": "google",
        "label": "Google",
        "count": 160,
        "avgRating": 4.5
      }
    ],
    "response": {
      "replied": 204,
      "unreplied": 6,
      "unrepliedNegative": 2,
      "rate": 97
    },
    "themes": [
      {
        "keyword": "friendly staff",
        "count": 42,
        "avgRating": 4.8,
        "sentiment": "positive"
      }
    ],
    "timing": [
      10,
      20,
      30,
      40,
      50,
      60,
      0
    ],
    "benchmark": {
      "rating": {
        "location": 4.4,
        "agency": 4.2
      },
      "responseRate": {
        "location": 91,
        "agency": 84
      }
    },
    "recentUnrepliedNegatives": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 2,
        "platform": "google",
        "platformLabel": "Google",
        "body": "Long wait time.",
        "date": "2026-02-01T12:00:00.000Z"
      }
    ],
    "aiSummary": "Ratings trended up this month, driven mostly by praise for staff friendliness."
  }
}

Guias que usam este endpoint