GET/api/v4/review-phrases

Formulierungen aus Bewertungen auflisten

Gibt die Formulierungen zurück, die Kunden in den Bewertungen eines Standorts am häufigsten verwenden, jeweils mit eigenen Bewertungsstatistiken.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Query

NameTypErforderlichBeschreibungStandard
locationIdsstringoptionalJSON array of location IDs to aggregate over, e.g. `[1800289,1800290]`. Query values are JSON-parsed, so a bare single ID also works. Omit to cover every location the key can read.—
siteUrlsstringoptionalJSON array of review sources to include, e.g. `["maps.google.com"]`.—
startDatestringoptionalOnly count reviews on or after this date (`YYYY-MM-DD`).—
endDatestringoptionalOnly count reviews on or before this date (`YYYY-MM-DD`).—
searchStringstringoptionalOnly return phrases containing this substring.—
phraseCountintegeroptionalMaximum number of phrases to return.—
categoriesstringoptionalJSON array of interaction categories to include (see the interaction attributes reference).—
ratingFiltersstringoptionalJSON array of star ratings to include, e.g. `[1,2]` to mine only unhappy reviews.—
responseStatusstringoptionalJSON array of `RESPONDED` / `PENDING` to restrict by whether the review has an owner reply.—
sortOrderstringoptionalOne of `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`, `LOWEST_RATING`, `HIGHEST_RATING`.—
categorystringoptionalDeprecated single-value form of `categories`. Kept for v4 compatibility; prefer `categories`.—
ratingFilterintegeroptionalDeprecated single-value form of `ratingFilters`. Kept for v4 compatibility; prefer `ratingFilters`.—

Antworten

200Phrases with their per-phrase review stats. Response key `newReviewPhrases`, a top-level array.
Response
{  "data": {    "newReviewPhrases": [      {        "reviewPhrase": "friendly staff",        "phraseStats": {          "stats": [            { "name": "total-reviews", "value": 46, "delta": 12.5, "abs": 5 },            { "name": "overall-rating", "value": 4.7, "delta": 1.1, "abs": 0.05 }          ]        }      },      {        "reviewPhrase": "long wait",        "phraseStats": {          "stats": [            { "name": "total-reviews", "value": 11, "delta": 37.5, "abs": 3 },            { "name": "overall-rating", "value": 2.9, "delta": -8.4, "abs": -0.27 }          ]        }      }    ]  }}
401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to read one of the requested locations (`SY90003`).

Gibt die wiederkehrenden Formulierungen in den Bewertungstexten eines Standorts zurück, jeweils mit den Bewertungsstatistiken für die Teilmenge der Bewertungen, die diese Formulierung enthalten. Damit wird die Frage beantwortet: „Was erwähnen Kunden immer wieder, und sind diese Erwähnungen positiv oder negativ?“.

data.newReviewPhrases ist ein Array auf oberster Ebene, keine paginierte Antwort. Verwenden Sie phraseCount, um seine Länge zu begrenzen.

Jeder Eintrag enthält:

  • reviewPhrase: die Formulierung selbst.
  • phraseStats.stats: dieselbe { name, value, delta }-Struktur wie bei Interaktionsanalysen abrufen, berechnet ausschließlich anhand der Bewertungen, die diese Formulierung enthalten, sowie ein abs-Feld mit der absoluten (statt prozentualen) Veränderung.

Alle Filter sind optional und lassen sich kombinieren, sodass die Route auch als Textsuche in Bewertungen dient: ratingFilters=[1,2] mit startDate liefert die Beschwerden des letzten Monats, sortiert nach der Häufigkeit ihres Auftretens.

Anwendungsfall: ein Bereich für die häufigsten Beschwerden

Um einen Beschwerdebereich für einen Standort zu erstellen, rufen Sie diese Route mit ratingFilters=[1,2], einem startDate, das 90 Tage zurückliegt, und phraseCount=10 auf. Das Ergebnis sind die zehn Formulierungen, die in Bewertungen mit niedriger Punktzahl am häufigsten vorkommen. Wenn Sie für jede Formulierung phraseStats für overall-rating auslesen, erfahren Sie, ob sie ein tatsächlicher Ausreißer oder einfach Teil des üblichen Wortschatzes ist, und delta zeigt, ob sich die Situation verschlechtert.

Da Abfragewerte als JSON geparst werden, werden Arrays im JSON-Format in der Abfragezeichenfolge übergeben: ?ratingFilters=[1,2]&siteUrls=["maps.google.com"].

Die obige Antwort ist ein Beispiel.

Request
curl -X GET 'https://listingsapi.com/api/v4/review-phrases' \  -H "Authorization: API $LISTINGSAPI_KEY"