/api/v4/locations/{locationId}/review-analytics-overviewObtener analíticas de interacciones
Devuelve un resumen de las analíticas de reseñas (KPI) de una ubicación. Dos rutas relacionadas devuelven una serie temporal y un desglose por sitio.
Parámetros
Ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| locationId | string | obligatorio | Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). |
Consulta
| Nombre | Tipo | Obligatorio | Descripción | Predeterminado |
|---|---|---|---|---|
| startDate | string | opcional | 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 | opcional | End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route. | — |
Respuestas
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.
Devuelve analíticas de reseñas de una sola ubicación. Esta ruta devuelve los KPI del resumen; dos rutas relacionadas devuelven los otros formatos de analíticas, cada una con su propia página:
review-analytics-overview(esta página): estadísticas generales:total-reviews,new-reviews,overall-rating(promedio, 1–5) yreview-response-rate(porcentaje). Clave de respuesta:interactionsAnalyticsStats.review-analytics-timeline: serie temporal diaria del número de interacciones y la valoración media para un intervalo de fechas. Clave de respuesta:interactionsChartData. RequierestartDateyendDate.review-analytics-sites-stats: desglose por plataforma que muestra la valoración media, el total de interacciones y la actividad reciente de cada sitio de origen. Clave de respuesta:interactionsSitesStats.
Cada entrada de stats contiene un name, un value y un delta. El delta es la variación porcentual respecto al período equivalente anterior (una cuenta nueva sin un período anterior indica 100).
Caso de uso: una tarjeta de indicadores de una ubicación
Para mostrar una tarjeta de «reseñas de un vistazo» en el panel de una tienda, llama a este endpoint solo con el ID de la ubicación; no se necesita un intervalo de fechas para el resumen. Lee overall-rating para obtener la valoración media en estrellas que se muestra como dato principal y review-response-rate para mostrar a cuántas reseñas ha respondido el equipo. Combínalo con review-analytics-timeline (pasando startDate/endDate) cuando la tarjeta necesite un minigráfico de la tendencia de 30 días.
El locationId acepta indistintamente el ID numérico sin procesar de la base de datos o el ID de Relay en Base64, por lo que puedes reutilizar el mismo ID que obtuviste de Listar todas las ubicaciones.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \ -H "Authorization: API $LISTINGSAPI_KEY"