Synup
Criar chave
v1Recursos/Reviews/getObter resumo de avaliações

Obter resumo de avaliações

Retorna um resumo consolidado de avaliações de toda a sua agência (ou de um cliente) — distribuição de notas, volume e tendência no período selecionado.

get/api/v1/reviews/summary
reviews:read
Parâmetros de consulta
clientIdstringopcional
Limita às avaliações de um cliente. Se omitido, resume todas as avaliações que sua chave pode ver.
tagsstringopcional
Limita a localizações com qualquer uma destas tags internas separadas por vírgula.
fromstringopcional
Início do intervalo de datas (inclusivo), no formato AAAA-MM-DD. Por padrão, uma janela recente contínua.
tostringopcional
Fim do intervalo de datas (inclusivo), no formato AAAA-MM-DD. Por padrão, hoje.
Resposta
dataobjectopcional
O resumo consolidado — distribuição de notas, volume de avaliações e dados de tendência para o período selecionado.
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/summary
Sua chave de API
clientId
tags
from
to
{
  "data": {
    "period": 30,
    "summary": {
      "locations": 5,
      "totalReviews": 210,
      "avgRating": 4.4,
      "totalUnreplied": 6,
      "positivePct": 82,
      "newInPeriod": 14,
      "newDelta": 3,
      "staleCount": 2,
      "deltas": {
        "totalReviews": 14,
        "avgRating": 0.1,
        "unreplied": -2,
        "positivePct": 4
      },
      "spark": {
        "counts": [
          1,
          2,
          0,
          3,
          1,
          2
        ],
        "ratings": [
          4,
          5,
          0,
          4,
          5,
          4
        ]
      }
    },
    "best": {
      "locationId": "cm_loc_1",
      "name": "Acme Dental — Downtown",
      "city": "Austin",
      "total": 90,
      "avgRating": 4.8,
      "positive": 78,
      "neutral": 8,
      "negative": 4,
      "replied": 88,
      "unreplied": 2,
      "unrepliedNegative": 0,
      "responseRate": 98,
      "benchmark": "good",
      "healthScore": 91,
      "ratingTrendDelta": 0.2,
      "velocityDelta": 6,
      "newInPeriod": 8,
      "daily": [
        1,
        2,
        0,
        3,
        1,
        2
      ],
      "lastReviewDate": "2026-02-05T09:00:00.000Z",
      "staleDays": null,
      "topPositiveTheme": "friendly staff",
      "topNegativeTheme": null,
      "tags": [
        "priority"
      ],
      "pct5": 70,
      "pctLte2": 4,
      "distribution": [
        1,
        3,
        8,
        22,
        56
      ],
      "netSentiment": 82,
      "oldestUnrepliedDays": 2,
      "daysSinceNegative": 9,
      "reviewsPerWeek": 1.9,
      "healthDelta": 3,
      "pctOfBook": 43
    },
    "worst": {
      "locationId": "cm_loc_2",
      "name": "Acme Dental — Eastside",
      "city": "Austin",
      "total": 60,
      "avgRating": 3.9,
      "positive": 38,
      "neutral": 12,
      "negative": 10,
      "replied": 40,
      "unreplied": 4,
      "unrepliedNegative": 2,
      "responseRate": 67,
      "benchmark": "improve",
      "healthScore": 58,
      "ratingTrendDelta": -0.1,
      "velocityDelta": 1,
      "newInPeriod": 6,
      "daily": [
        0,
        1,
        1,
        0,
        2,
        1
      ],
      "lastReviewDate": "2026-02-04T09:00:00.000Z",
      "staleDays": null,
      "topPositiveTheme": "clean office",
      "topNegativeTheme": "wait time",
      "tags": [],
      "pct5": 45,
      "pctLte2": 12,
      "distribution": [
        3,
        4,
        12,
        15,
        26
      ],
      "netSentiment": 47,
      "oldestUnrepliedDays": 6,
      "daysSinceNegative": 1,
      "reviewsPerWeek": 1.4,
      "healthDelta": -2,
      "pctOfBook": 29
    },
    "rows": [],
    "trend": {
      "months": [
        "2026-01",
        "2026-02"
      ],
      "locations": [
        {
          "locationId": "cm_loc_1",
          "name": "Acme Dental — Downtown",
          "healthScore": 91,
          "count": [
            42,
            48
          ],
          "avgRating": [
            4.6,
            4.8
          ]
        }
      ]
    }
  }
}

Guias que usam este endpoint