Listar expressões das avaliações

Parâmetros

Query

Nome	Tipo	Obrigatório	Descrição	Padrão
locationIds	string	opcional	JSON 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.	—
siteUrls	string	opcional	JSON array of review sources to include, e.g. `["maps.google.com"]`.	—
startDate	string	opcional	Only count reviews on or after this date (`YYYY-MM-DD`).	—
endDate	string	opcional	Only count reviews on or before this date (`YYYY-MM-DD`).	—
searchString	string	opcional	Only return phrases containing this substring.	—
phraseCount	integer	opcional	Maximum number of phrases to return.	—
categories	string	opcional	JSON array of interaction categories to include (see the interaction attributes reference).	—
ratingFilters	string	opcional	JSON array of star ratings to include, e.g. `[1,2]` to mine only unhappy reviews.	—
responseStatus	string	opcional	JSON array of `RESPONDED` / `PENDING` to restrict by whether the review has an owner reply.	—
sortOrder	string	opcional	One of `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`, `LOWEST_RATING`, `HIGHEST_RATING`.	—
category	string	opcional	Deprecated single-value form of `categories`. Kept for v4 compatibility; prefer `categories`.	—
ratingFilter	integer	opcional	Deprecated single-value form of `ratingFilters`. Kept for v4 compatibility; prefer `ratingFilters`.	—

Respostas

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`).

Retorna as expressões recorrentes no texto das avaliações de um local, cada uma com as estatísticas do subconjunto de avaliações que a contêm. Responde à pergunta "o que os clientes continuam mencionando, e essas menções são positivas ou negativas?".

data.newReviewPhrases é um array de nível superior, não uma resposta paginada. Use phraseCount para limitar seu tamanho.

Cada entrada tem:

reviewPhrase: a própria expressão.
phraseStats.stats: a mesma estrutura { name, value, delta } de Obter análises de interações, calculada apenas sobre as avaliações que contêm essa expressão, além de um campo abs que contém a variação absoluta (em vez da percentual).

Todos os filtros são opcionais e podem ser combinados, portanto a rota também funciona como uma busca textual nas avaliações: ratingFilters=[1,2] com startDate retorna as reclamações do último mês, classificadas pela frequência com que se repetem.

Caso de uso: um painel de "principais reclamações"

Para criar um painel de reclamações de um local, chame esta rota com ratingFilters=[1,2], um valor de startDate correspondente a 90 dias atrás e phraseCount=10. O resultado são as dez expressões que mais aparecem em avaliações com notas baixas. Consultar phraseStats para overall-rating em cada uma delas permite que você saiba se uma expressão realmente foge do padrão ou é simplesmente vocabulário comum, e delta indica se ela está piorando.

Como os valores dos parâmetros de consulta são interpretados como JSON, os arrays são incluídos na string de consulta no formato JSON: ?ratingFilters=[1,2]&siteUrls=["maps.google.com"].

A resposta acima é um exemplo.