/api/v4/locations/{locationId}/review-analytics-overviewOttieni le analisi delle interazioni
Restituisce i KPI riepilogativi delle recensioni per una sede. Due route correlate offrono una serie temporale e una ripartizione per sito.
Parametri
Percorso
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| locationId | string | obbligatorio | Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). |
Query
| Nome | Tipo | Obbligatorio | Descrizione | Predefinito |
|---|---|---|---|---|
| startDate | string | facoltativo | 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 | facoltativo | End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route. | — |
Risposte
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.
Restituisce le analisi delle recensioni per una singola sede. Questa route restituisce i KPI riepilogativi; due route correlate restituiscono gli altri formati di analisi, ciascuna con una propria pagina:
review-analytics-overview(questa pagina): statistiche complessive:total-reviews,new-reviews,overall-rating(media, 1–5) ereview-response-rate(percentuale). Chiave della risposta:interactionsAnalyticsStats.review-analytics-timeline: serie temporale giornaliera del numero di interazioni e della valutazione media per un intervallo di date. Chiave della risposta:interactionsChartData. RichiedestartDateeendDate.review-analytics-sites-stats: ripartizione per piattaforma che mostra la valutazione media, le interazioni totali e l'attività recente per ciascun sito di origine. Chiave della risposta:interactionsSitesStats.
Ogni voce in stats contiene un name, un value e un delta. Il valore di delta è la variazione percentuale rispetto al periodo equivalente precedente (un account appena creato senza un periodo precedente riporta 100).
Caso d'uso: un riquadro riepilogativo delle prestazioni di una sede
Per visualizzare un riquadro "recensioni a colpo d'occhio" nella dashboard di un negozio, chiama questo endpoint con il solo ID della sede; per il riepilogo non è necessario un intervallo di date. Leggi overall-rating per la valutazione media in stelle da mettere in evidenza e review-response-rate per mostrare a quante recensioni il team ha risposto. Abbinalo a review-analytics-timeline (passando startDate/endDate) quando il riquadro deve includere un minigrafico dell'andamento su 30 giorni.
locationId accetta indifferentemente l'ID numerico originale del database o l'ID Relay in Base64, quindi puoi riutilizzare lo stesso ID restituito da Elenca tutte le sedi.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \ -H "Authorization: API $LISTINGSAPI_KEY"