/api/v4/locations/{locationId}/review-analytics-overviewObter análises de interações
Retorna uma visão geral das análises de avaliações (KPIs) de um local. Duas rotas relacionadas retornam uma série temporal e um detalhamento por site.
Parâmetros
Caminho
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| locationId | string | obrigatório | Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). |
Query
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
| startDate | string | opcional | Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route. | — |
| endDate | string | opcional | End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route. | — |
Respostas
200Overview analytics for the location.
{ "data": { "interactionsAnalyticsStats": { "stats": [ { "name": "total-reviews", "value": 128, "delta": 6.67 }, { "name": "new-reviews", "value": 9, "delta": -25 }, { "name": "overall-rating", "value": 4.43, "delta": 2.31 }, { "name": "review-response-rate", "value": 62.5, "delta": 12.5 } ] } }}401Unauthenticated, missing or invalid API key.
Retorna análises de avaliações de um único local. Esta rota retorna os KPIs da visão geral; duas rotas relacionadas retornam os outros formatos de análise, cada uma com sua própria página:
review-analytics-overview(esta página): estatísticas gerais:total-reviews,new-reviews,overall-rating(média, de 1 a 5) ereview-response-rate(porcentagem). Chave da resposta:interactionsAnalyticsStats.review-analytics-timeline: série temporal diária da contagem de interações e da nota média em um intervalo de datas. Chave da resposta:interactionsChartData. RequerstartDateeendDate.review-analytics-sites-stats: detalhamento por plataforma que mostra a nota média, o total de interações e a atividade recente de cada site de origem. Chave da resposta:interactionsSitesStats.
Cada entrada em stats contém um name, um value e um delta. O delta é a variação percentual em relação ao período equivalente anterior (uma conta nova sem período anterior informa 100).
Caso de uso: um cartão de indicadores de um local
Para exibir um cartão de "avaliações em resumo" no painel de uma loja, chame este endpoint apenas com o ID do local; nenhum intervalo de datas é necessário para a visão geral. Leia overall-rating para obter a média de estrelas em destaque e review-response-rate para mostrar a quantas avaliações a equipe respondeu. Combine-o com review-analytics-timeline (passando startDate/endDate) quando o cartão precisar de um minigráfico de tendência de 30 dias.
O locationId aceita tanto o ID numérico bruto do banco de dados quanto o ID Relay em Base64 de forma intercambiável, então você pode reutilizar o mesmo ID recebido de Listar todos os locais.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \ -H "Authorization: API $LISTINGSAPI_KEY"