Listar frases de reseñas

Parámetros

Consulta

Nombre	Tipo	Obligatorio	Descripción	Predeterminado
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`.	—

Respuestas

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

Devuelve las frases recurrentes en el texto de las reseñas de una ubicación, cada una con las estadísticas del subconjunto de reseñas que la contienen. Responde a la pregunta «¿qué mencionan los clientes una y otra vez, y son esas menciones positivas o negativas?».

data.newReviewPhrases es un array de nivel superior, no una respuesta paginada. Usa phraseCount para limitar su longitud.

Cada entrada contiene:

reviewPhrase: la frase en sí.
phraseStats.stats: la misma estructura { name, value, delta } que en Obtener analíticas de interacciones, calculada únicamente a partir de las reseñas que contienen esa frase, más un campo abs que contiene la variación absoluta (en lugar de porcentual).

Todos los filtros son opcionales y se pueden combinar, por lo que la ruta también sirve para realizar búsquedas de texto en las reseñas: ratingFilters=[1,2] con startDate devuelve las quejas del último mes, ordenadas por la frecuencia con la que se repiten.

Caso de uso: un panel de «quejas más frecuentes»

Para crear un panel de quejas para una ubicación, llama a esta ruta con ratingFilters=[1,2], un startDate de hace 90 días y phraseCount=10. El resultado son las diez frases que aparecen con mayor frecuencia en las reseñas con puntuaciones bajas. Consultar phraseStats para overall-rating en cada una te indica si una frase es realmente atípica o simplemente vocabulario común, y delta indica si está empeorando.

Como los valores de consulta se analizan como JSON, los arrays se incluyen en la cadena de consulta en formato JSON: ?ratingFilters=[1,2]&siteUrls=["maps.google.com"].

La respuesta anterior es un ejemplo.