Synupv1
Crear clave
v1Recursos/Reviews

Reviews

Consulte y responda a las reseñas de clientes de una ubicación.

Devuelve reseñas de una ubicación. Se requieren tanto locationId como clientId.

Listar reseñas

get/api/v1/reviews
reviews:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringobligatorio
El cliente de la ubicación.
sitesstringopcional
Plataformas de reseñas a incluir, separadas por comas (p. ej. google,facebook).
ratingsstringopcional
Calificaciones en estrellas a incluir, separadas por comas (p. ej. 1,2).
sentimentstringopcional
Sentimientos a incluir, separados por comas (positive, neutral, negative).
statusstring (responded | unreplied)opcional
Filtrar por estado de respuesta: responded o unreplied.
keywordstringopcional
Búsqueda de texto libre en el cuerpo de la reseña y el autor.
fromstringopcional
Inicio de la ventana (fecha ISO).
tostringopcional
Fin de la ventana (fecha ISO).
sortstring (newest | oldest | lowest | highest)opcional
Orden: newest, oldest, lowest o highest.
deletedstring (1)opcional
Pase 1 para mostrar reseñas eliminadas/no presentes en lugar de las activas.
cursorstringopcional
Cursor de paginación del nextCursor de una respuesta anterior.
limitintegeropcional
Reseñas por página, 1-100. Por defecto 30.
Respuesta
dataobjectopcional
foundbooleanopcional
Si la ubicación se encontró y era accesible para esta clave.
reviewsarray of objectopcional
Las reseñas en sí.
idstringopcional
Identificador único de la reseña.
authorstringopcional
Nombre de quien escribió la reseña, o null si la fuente no lo proporcionó.
ratingnumberopcional
Calificación en estrellas, o null.
bodystringopcional
El texto de la reseña.
reviewDatestringopcional
Fecha de publicación de la reseña, como marca de tiempo ISO 8601, o null.
platformstringopcional
Plataforma de origen, p. ej. google, facebook.
platformLabelstringopcional
Nombre visible de la plataforma de origen, o null.
sentimentstringopcional
Sentimiento detectado de la reseña, o null.
replyobjectopcional
La respuesta del negocio, si la hay, o null.
authorstringopcional
bodystringopcional
datestringopcional
reviewUrlstringopcional
Enlace a la reseña en su plataforma de origen, o null.
respondablebooleanopcional
Si todavía se puede publicar una respuesta a esta reseña.
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalnumberopcional
Número total de reseñas que coinciden con la solicitud.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews
Su clave de API
locationId *
clientId *
sites
ratings
sentiment
status
keyword
from
to
sort
deleted
cursor
limit
{
  "data": {
    "found": true,
    "reviews": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 5,
        "body": "Great service!",
        "reviewDate": "2026-02-01T12:00:00.000Z",
        "platform": "google",
        "platformLabel": "Google",
        "sentiment": "positive",
        "reply": null,
        "reviewUrl": "https://google.com/...",
        "respondable": true
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Recursos/Reviews/getObtener resumen de reseñas

Devuelve un resumen consolidado de reseñas de toda tu agencia (o de un cliente) — distribución de calificaciones, volumen y tendencia en el período seleccionado.

Obtener resumen de reseñas

get/api/v1/reviews/summary
reviews:read
Parámetros de consulta
clientIdstringopcional
Limita a las reseñas de un cliente. Si se omite, se resumen todas las reseñas que tu clave puede ver.
tagsstringopcional
Limita a ubicaciones con alguna de estas etiquetas internas separadas por comas.
fromstringopcional
Inicio del rango de fechas (inclusivo), como AAAA-MM-DD. Por defecto, una ventana móvil reciente.
tostringopcional
Fin del rango de fechas (inclusivo), como AAAA-MM-DD. Por defecto, hoy.
Respuesta
dataobjectopcional
El resumen consolidado — distribución de calificaciones, volumen de reseñas y datos de tendencia para el período seleccionado.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/summary
Su clave de API
clientId
tags
from
to
{}
v1Recursos/Reviews/getListar fuentes de reseñas

Cada fuente de reseñas de una ubicación — plataformas conectadas (Google, Facebook, ...) además de URLs personalizadas (Yelp, TripAdvisor, ...), con estado y estado de ocultación.

Listar fuentes de reseñas

get/api/v1/reviews/sources
reviews:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringobligatorio
El cliente de la ubicación.
Respuesta
dataobjectopcional
sourcesarray of objectopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/sources
Su clave de API
locationId *
clientId *
{}
v1Recursos/Reviews/postAgregar una fuente de reseñas personalizada

Agrega una URL de página de reseñas personalizada (Yelp, TripAdvisor, Trustpilot o cualquier página de reseñas de negocios) como fuente para esta ubicación. La plataforma se detecta automáticamente a partir de la URL. No valida la URL en vivo antes de agregarla — una URL incorrecta se manifiesta después como un scrape fallido.

Agregar una fuente de reseñas personalizada

post/api/v1/reviews/sources
reviews:write
Cuerpo de la solicitud
locationIdstringobligatorio
clientIdstringobligatorio
urlstringobligatorio
La URL de la página de reseñas a agregar.
Respuesta
dataobjectopcional
idstringopcional
El id de la fuente personalizada recién creada.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
409Esta URL ya es una fuente para esta ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/sources
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/patchActualizar una fuente de reseñas

Oculta/muestra una fuente (plataforma automática o personalizada), o cambia el intervalo de obtención de una fuente personalizada.

Actualizar una fuente de reseñas

patch/api/v1/reviews/sources/{id}
reviews:write
Parámetros de consulta
idstringobligatorio
La clave de la fuente — un slug de plataforma automática (p. ej. "google") o el id de una fuente personalizada.
Cuerpo de la solicitud
typestring (auto | custom)obligatorio
locationIdstringobligatorio
clientIdstringobligatorio
hidebooleanopcional
Establezca true para ocultar esta fuente de la vista de reseñas, false para mostrarla.
fetchIntervalHoursintegeropcional
Nuevo intervalo de scrape en horas. Solo fuentes personalizadas.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/reviews/sources/{id}
Su clave de API
id *
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/deleteEliminar una fuente de reseñas personalizada

Elimina permanentemente una fuente de reseñas personalizada y detiene su extracción.

Eliminar una fuente de reseñas personalizada

delete/api/v1/reviews/sources/{id}
reviews:write
Parámetros de consulta
idstringobligatorio
locationIdstringobligatorio
clientIdstringobligatorio
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/reviews/sources/{id}
Su clave de API
id *
locationId *
clientId *
{}
v1Recursos/Reviews/postReintentar una fuente de reseñas atascada/fallida

Restablece el estado de fallo de una fuente personalizada y la vuelve a poner en cola para un scrape inmediato.

Reintentar una fuente de reseñas atascada/fallida

post/api/v1/reviews/sources/{id}/retry
reviews:write
Parámetros de consulta
idstringobligatorio
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/sources/{id}/retry
Su clave de API
id *
{}
v1Recursos/Reviews/getObtener análisis de reseñas

KPIs (con deltas período a período), una tendencia mensual (volumen, calificación, mezcla de sentimiento, tasa de respuesta), distribución de calificaciones, desglose por plataforma, horario por día de la semana, un benchmark de la agencia, temas y un resumen de IA — para una ubicación.

Obtener análisis de reseñas

get/api/v1/reviews/analytics
reviews:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringobligatorio
El cliente de la ubicación.
kpiDaysinteger (7 | 30 | 90)opcional
Ventana de KPI en días: 7, 30 o 90. Por defecto 30.
trendMonthsinteger (3 | 6 | 12)opcional
Duración de la tendencia en meses: 3, 6 o 12. Por defecto 6.
Respuesta
dataobjectopcional
El payload completo de Análisis de Reseñas.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/analytics
Su clave de API
locationId *
clientId *
kpiDays
trendMonths
{}
v1Recursos/Reviews/getObtener un resumen de análisis de reseñas

Análisis de reseñas agregado en las ubicaciones de este cliente (o de toda la agencia): cantidad, calificación promedio, distribución de calificaciones, mezcla de sentimiento, tasa de respuesta, desglose por plataforma y una tendencia mensual. Limite el alcance con tags.

Obtener un resumen de análisis de reseñas

get/api/v1/reviews/analytics/summary
reviews:read
Parámetros de consulta
clientIdstringopcional
Limitar a las ubicaciones de un cliente.
tagsstringopcional
Nombres de tags de ubicación separados por comas — solo se incluyen las ubicaciones con al menos uno de estos.
monthsintegeropcional
Duración de la tendencia en meses. Por defecto 6.
Respuesta
dataobjectopcional
locationsnumberopcional
Número de ubicaciones en el alcance.
countnumberopcional
Total de reseñas en el alcance.
avgRatingnumberopcional
Calificación promedio en el alcance.
distributionobjectopcional
Cantidad de reseñas por calificación en estrellas (1-5).
sentimentobjectopcional
Cantidad de reseñas por sentimiento.
positivenumberopcional
neutralnumberopcional
negativenumberopcional
responseRatenumberopcional
Porcentaje de reseñas con respuesta.
byPlatformarray of objectopcional
Cantidad y calificación promedio por plataforma.
platformstringopcional
countnumberopcional
avgRatingnumberopcional
trendarray of objectopcional
Cantidad mensual y calificación promedio.
monthstringopcional
countnumberopcional
avgRatingnumberopcional
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/analytics/summary
Su clave de API
clientId
tags
months
{}
v1Recursos/Reviews/getListar competidores rastreados

Los competidores rastreados para una ubicación.

Listar competidores rastreados

get/api/v1/reviews/competitors
reviews:read
Parámetros de consulta
locationIdstringopcional
apiDocs.resources.reviews.competitors.get.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.competitors.get.paramsClientId
Respuesta
dataobjectopcional
competitorsarray of objectopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/competitors
Su clave de API
locationId
clientId
{}
v1Recursos/Reviews/postAgregar un competidor

Comienza a rastrear un competidor por nombre para una ubicación.

Agregar un competidor

post/api/v1/reviews/competitors
reviews:write
Cuerpo de la solicitud
locationIdstringopcional
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.competitors.post.paramsClientId
namestringobligatorio
El nombre comercial del competidor.
Respuesta
dataobjectopcional
competitorobjectopcional
Fila de perfil de un competidor (id, nombre, origen, fijado, etc.).
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/competitors
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/getObtener análisis competitivo de reseñas

Compara las reseñas de una ubicación con sus competidores rastreados: tarjeta de puntuación, fortalezas/brechas, y velocidad de reseñas + share of voice.

Obtener análisis competitivo de reseñas

get/api/v1/reviews/competitors/analysis
reviews:read
Parámetros de consulta
locationIdstringobligatorio
clientIdstringobligatorio
Respuesta
dataobjectopcional
El payload completo del análisis competitivo (tarjeta de puntuación, fortalezas/brechas, velocidad).
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/competitors/analysis
Su clave de API
locationId *
clientId *
{}
v1Recursos/Reviews/deleteEliminar un competidor rastreado

Deja de rastrear permanentemente un competidor por su id.

Eliminar un competidor rastreado

delete/api/v1/reviews/competitors/{id}
reviews:write
Parámetros de consulta
idstringobligatorio
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/reviews/competitors/{id}
Su clave de API
id *
{}
v1Recursos/Reviews/postActualizar las reseñas de un competidor

Vuelve a extraer las reseñas de Google de un competidor rastreado.

Actualizar las reseñas de un competidor

post/api/v1/reviews/competitors/{id}/refresh
reviews:write
Parámetros de consulta
idstringobligatorio
Respuesta
dataobjectopcional
okbooleanopcional
notestringopcional
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/competitors/{id}/refresh
Su clave de API
id *
{}
v1Recursos/Reviews/postapiDocs.resources.reviews.competitorsRefresh.summary

apiDocs.resources.reviews.competitorsRefresh.description

apiDocs.resources.reviews.competitorsRefresh.summary

post/api/v1/reviews/competitors/refresh
reviews:write
Cuerpo de la solicitud
clientIdstringobligatorio
apiDocs.resources.reviews.competitorsRefresh.paramsClientId
Respuesta
dataobjectopcional
okbooleanopcional
queuedbooleanopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/competitors/refresh
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/getapiDocs.resources.reviews.notes.get.summary

apiDocs.resources.reviews.notes.get.description

apiDocs.resources.reviews.notes.get.summary

get/api/v1/reviews/notes
reviews:read
Parámetros de consulta
reviewIdstringobligatorio
apiDocs.resources.reviews.notes.get.paramsReviewId
Respuesta
dataobjectopcional
notesarray of objectopcional
idstringopcional
apiDocs.resources.reviews.notes.fields.id
bodystringopcional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringopcional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringopcional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringopcional
apiDocs.resources.reviews.notes.fields.createdAt
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/notes
Su clave de API
reviewId *
{}
v1Recursos/Reviews/postapiDocs.resources.reviews.notes.post.summary

apiDocs.resources.reviews.notes.post.description

apiDocs.resources.reviews.notes.post.summary

post/api/v1/reviews/notes
reviews:write
Cuerpo de la solicitud
reviewIdstringobligatorio
apiDocs.resources.reviews.notes.post.paramsReviewId
bodystringobligatorio
apiDocs.resources.reviews.notes.post.paramsBody
Respuesta
dataobjectopcional
idstringopcional
apiDocs.resources.reviews.notes.fields.id
bodystringopcional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringopcional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringopcional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringopcional
apiDocs.resources.reviews.notes.fields.createdAt
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/notes
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/deleteapiDocs.resources.reviews.notes.delete.summary

apiDocs.resources.reviews.notes.delete.description

apiDocs.resources.reviews.notes.delete.summary

delete/api/v1/reviews/notes
reviews:write
Parámetros de consulta
reviewIdstringobligatorio
apiDocs.resources.reviews.notes.delete.paramsReviewId
noteIdstringobligatorio
apiDocs.resources.reviews.notes.delete.paramsNoteId
Respuesta
dataobjectopcional
deletedbooleanopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/reviews/notes
Su clave de API
reviewId *
noteId *
{}
v1Recursos/Reviews/postapiDocs.resources.reviews.topicKeywords.post.summary

apiDocs.resources.reviews.topicKeywords.post.description

apiDocs.resources.reviews.topicKeywords.post.summary

post/api/v1/reviews/topic-trends/keywords
reviews:write
Cuerpo de la solicitud
locationIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatorio
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Respuesta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
queuedbooleanopcional
notestringopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/topic-trends/keywords
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/deleteapiDocs.resources.reviews.topicKeywords.delete.summary

apiDocs.resources.reviews.topicKeywords.delete.description

apiDocs.resources.reviews.topicKeywords.delete.summary

delete/api/v1/reviews/topic-trends/keywords
reviews:write
Parámetros de consulta
locationIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatorio
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Respuesta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/reviews/topic-trends/keywords
Su clave de API
locationId
clientId
keyword *
{}
v1Recursos/Reviews/patchapiDocs.resources.reviews.topicKeywords.patch.summary

apiDocs.resources.reviews.topicKeywords.patch.description

apiDocs.resources.reviews.topicKeywords.patch.summary

patch/api/v1/reviews/topic-trends/keywords
reviews:write
Cuerpo de la solicitud
locationIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatorio
apiDocs.resources.reviews.topicKeywords.paramsKeyword
hidebooleanobligatorio
apiDocs.resources.reviews.topicKeywords.paramsHide
Respuesta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
hiddenarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsHidden
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/reviews/topic-trends/keywords
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/getObtener tendencias de temas

Una serie temporal agrupada por tema de reseña, una tabla de clasificación, movimientos ascendentes/descendentes, y temas emergentes/desvanecidos — para una ubicación.

Obtener tendencias de temas

get/api/v1/reviews/topic-trends
reviews:read
Parámetros de consulta
locationIdstringobligatorio
clientIdstringobligatorio
windowDaysinteger (30 | 90 | 180)opcional
Ventana de tendencia en días: 30, 90 o 180. Por defecto 90.
Respuesta
dataobjectopcional
El payload completo de Tendencias de Temas.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/topic-trends
Su clave de API
locationId *
clientId *
windowDays
{}
v1Recursos/Reviews/getObtener una serie mensual más larga de un tema

Una serie mes a mes más larga para los temas, más allá de la ventana de tendencia estándar.

Obtener una serie mensual más larga de un tema

get/api/v1/reviews/topic-trends/series
reviews:read
Parámetros de consulta
locationIdstringobligatorio
clientIdstringobligatorio
monthsintegeropcional
Duración de la serie en meses. Por defecto 12.
Respuesta
dataobjectopcional
El payload completo de la serie mensual de temas.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/topic-trends/series
Su clave de API
locationId *
clientId *
months
{}
v1Recursos/Reviews/getObtener reseñas que mencionan un tema

Profundice en las reseñas que mencionan un tema, opcionalmente acotado a un mes.

Obtener reseñas que mencionan un tema

get/api/v1/reviews/topic-trends/reviews
reviews:read
Parámetros de consulta
locationIdstringobligatorio
clientIdstringobligatorio
topicstringobligatorio
El tema a consultar (de GET /api/v1/reviews/topic-trends).
monthstringopcional
Acotar a una celda del mapa de calor (AAAA-MM). Omitir para el historial completo.
limitintegeropcional
Máximo de reseñas a devolver.
Respuesta
dataobjectopcional
reviewsarray of objectopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/topic-trends/reviews
Su clave de API
locationId *
clientId *
topic *
month
limit
{}
v1Recursos/Reviews/getListar widgets de reseñas

Cada widget de reseñas configurado para una ubicación.

Listar widgets de reseñas

get/api/v1/reviews/widgets
reviews:read
Parámetros de consulta
locationIdstringobligatorio
clientIdstringobligatorio
Respuesta
dataobjectopcional
widgetsarray of objectopcional
idstringopcional
agencyIdstringopcional
locationIdstringopcional
clientLocationIdstringopcional
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
createdAtstringopcional
updatedAtstringopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/widgets
Su clave de API
locationId *
clientId *
{}
v1Recursos/Reviews/postCrear un widget de reseñas

Crea un nuevo widget de reseñas incrustable (insignia de calificación + carrusel/lista de reseñas) para una ubicación.

Crear un widget de reseñas

post/api/v1/reviews/widgets
reviews:write
Cuerpo de la solicitud
locationIdstringobligatorio
clientIdstringobligatorio
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstring (30d | 90d | 1y | all)opcional
countintegeropcional
includeInternalbooleanopcional
layoutstringopcional
statusstring (draft | published)opcional
Respuesta
dataobjectopcional
widgetobjectopcional
idstringopcional
agencyIdstringopcional
locationIdstringopcional
clientLocationIdstringopcional
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
createdAtstringopcional
updatedAtstringopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/widgets
Su clave de API
Cuerpo de la solicitud*
{}
v1Recursos/Reviews/getObtener un widget de reseñas

Devuelve la configuración completa de un widget de reseñas.

Obtener un widget de reseñas

get/api/v1/reviews/widgets/{id}
reviews:read
Parámetros de consulta
idstringobligatorio
Respuesta
dataobjectopcional
widgetobjectopcional
idstringopcional
agencyIdstringopcional
locationIdstringopcional
clientLocationIdstringopcional
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
createdAtstringopcional
updatedAtstringopcional
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/reviews/widgets/{id}
Su clave de API
id *
{}
v1Recursos/Reviews/patchActualizar un widget de reseñas

Actualiza la configuración o el diseño de un widget (o lo publica, mediante status).

Actualizar un widget de reseñas

patch/api/v1/reviews/widgets/{id}
reviews:write
Parámetros de consulta
idstringobligatorio
Cuerpo de la solicitud
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
Respuesta
dataobjectopcional
widgetobjectopcional
idstringopcional
agencyIdstringopcional
locationIdstringopcional
clientLocationIdstringopcional
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
createdAtstringopcional
updatedAtstringopcional
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/reviews/widgets/{id}
Su clave de API
id *
Cuerpo de la solicitud
{}
v1Recursos/Reviews/deleteEliminar un widget de reseñas

Elimina permanentemente un widget de reseñas. El widget incrustado público deja de funcionar una vez eliminado.

Eliminar un widget de reseñas

delete/api/v1/reviews/widgets/{id}
reviews:write
Parámetros de consulta
idstringobligatorio
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/reviews/widgets/{id}
Su clave de API
id *
{}
v1Recursos/Reviews/postResponder a una reseña

Publica una respuesta del negocio a una reseña y la envía a la plataforma de origen. Falla con un error de regla de negocio (422) si no se puede responder a la reseña — p. ej. porque se eliminó de su fuente.

Responder a una reseña

post/api/v1/reviews/reply
reviews:write
Cuerpo de la solicitud
reviewIdstringobligatorio
La reseña a la que responder. Obligatorio.
textstringobligatorio
El texto de la respuesta a publicar. Obligatorio.
Respuesta
dataobjectopcional
okbooleanopcional
Si la respuesta fue aceptada.
pushedbooleanopcional
Si la respuesta se envió realmente a la plataforma de origen (en lugar de quedar en cola).
statusstring (posted | pending | failed | draft)opcional
Uno de: posted, pending, failed, draft.
externalReplyIdstringopcional
El id de la respuesta en la plataforma de origen, o null.
retryablebooleanopcional
Si el envío falló, si reintentarlo podría tener éxito — null cuando no aplica.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/reply
Su clave de API
Cuerpo de la solicitud*
{}