/api/v4/locations/{locationId}/review-analytics-overviewInteraktionsanalysen abrufen
Liefert eine Übersicht der Bewertungs-KPIs für einen Standort. Zwei verwandte Routen liefern eine Zeitreihe und eine Aufschlüsselung nach Website.
Parameter
Pfad
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| locationId | string | erforderlich | Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). |
Query
| Name | Typ | Erforderlich | Beschreibung | Standard |
|---|---|---|---|---|
| startDate | string | optional | 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 | optional | End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route. | — |
Antworten
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.
Gibt Bewertungsanalysen für einen einzelnen Standort zurück. Diese Route gibt die Übersichts-KPIs zurück; zwei verwandte Routen geben die anderen Analyseformen zurück und haben jeweils eine eigene Seite:
review-analytics-overview(diese Seite): Gesamtstatistiken:total-reviews,new-reviews,overall-rating(Durchschnitt, 1–5) undreview-response-rate(Prozentsatz). Antwortschlüssel:interactionsAnalyticsStats.review-analytics-timeline: tägliche Zeitreihe der Interaktionsanzahl und der durchschnittlichen Bewertung für einen Datumsbereich. Antwortschlüssel:interactionsChartData. ErfordertstartDateundendDate.review-analytics-sites-stats: Aufschlüsselung nach Plattform mit der durchschnittlichen Bewertung, der Gesamtzahl der Interaktionen und den jüngsten Aktivitäten für jede Quellwebsite. Antwortschlüssel:interactionsSitesStats.
Jeder Eintrag in stats enthält name, value und delta. delta ist die prozentuale Änderung gegenüber dem vorherigen gleich langen Zeitraum (bei einem neuen Konto ohne vorherigen Zeitraum wird 100 gemeldet).
Anwendungsfall: eine Kennzahlenkachel für einen Standort
Um eine Kachel „Bewertungen auf einen Blick“ für das Dashboard eines Geschäfts darzustellen, rufen Sie diesen Endpunkt nur mit der Standort-ID auf; für die Übersicht ist kein Datumsbereich erforderlich. Lesen Sie overall-rating für den hervorgehobenen Sterndurchschnitt und review-response-rate, um anzuzeigen, wie viele Bewertungen das Team beantwortet hat. Kombinieren Sie dies mit review-analytics-timeline (unter Übergabe von startDate/endDate), wenn die Kachel eine Sparkline für den 30-Tage-Trend benötigt.
locationId akzeptiert wahlweise die unveränderte numerische Datenbank-ID oder die Base64-Relay-ID, sodass Sie dieselbe ID wiederverwenden können, die Sie von Alle Standorte auflisten erhalten haben.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \ -H "Authorization: API $LISTINGSAPI_KEY"