GET/api/v4/locations/{locationId}/review-analytics-timeline

Obter a série temporal de análises de avaliações

Retorna uma série temporal diária do volume de avaliações e da nota média de um local.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
locationIdstringobrigatórioLocation ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

Query

NomeTipoObrigatórioDescriçãoPadrão
startDatestringopcionalFirst day of the series (`YYYY-MM-DD`). Omitting it lets the service pick its default window, so pass it whenever the chart's range matters.—
endDatestringopcionalLast day of the series (`YYYY-MM-DD`).—
sitestringopcionalRestrict the series to a single review source, by site URL (e.g. `maps.google.com`). Omit for all sources combined.—

Respostas

200One entry per day in the requested range. Response key `interactionsChartData`.
Response
{  "data": {    "interactionsChartData": {      "data": [        { "date": "2026-08-01", "interactionCount": 4, "averageRating": 4.5 },        { "date": "2026-08-02", "interactionCount": 0, "averageRating": null },        { "date": "2026-08-03", "interactionCount": 7, "averageRating": 4.285714285714286 }      ]    }  }}
401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to read this location (`SY90003`).

Retorna a série diária de avaliações que serve de base para um gráfico de tendências: quantas avaliações chegaram em cada data e a nota média em estrelas dessas avaliações. É a versão em série temporal de Obter análises de interações (KPIs gerais) e Obter análises de avaliações por site (detalhamento por origem).

Cada entrada contém três campos:

  • date: o dia do calendário, no formato YYYY-MM-DD.
  • interactionCount: avaliações recebidas naquele dia.
  • averageRating: nota média em estrelas das avaliações daquele dia, com valor null em um dia sem avaliações. É a média diária, não uma média acumulada, portanto uma única avaliação de 1 estrela em um dia de pouco movimento aparece como 1.0 mesmo para uma loja bem avaliada.

Caso de uso: um minigráfico de 30 dias

Para exibir a tendência de 30 dias abaixo da média em estrelas de um local, chame esta rota com startDate e endDate abrangendo o período e represente interactionCount como barras e averageRating como uma linha. Combine-a com a rota de visão geral para obter os números principais; os campos delta da visão geral já fazem a comparação com o período equivalente anterior, então você não precisa buscar dois períodos por conta própria.

Passe site para separar a série por origem, por exemplo, para mostrar que uma queda na nota veio de uma plataforma, em vez de ocorrer em todas elas. O valor é a URL do site conforme aparece em siteSettings[].name de Listar origens de avaliações de um local.

A resposta acima é um exemplo.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-timeline' \  -H "Authorization: API $LISTINGSAPI_KEY"