Synupv1
Crear clave
v1Recursos/Clients

Clients

Cree, lea, actualice y archive los clientes (empresas) de su agencia.

Devuelve una página de los clientes de su agencia, empezando por los más recientes. Todos los filtros son opcionales y se combinan (un cliente debe cumplir con todos ellos); para avanzar a más resultados, vuelva a enviar el nextCursor devuelto.

Listar / buscar clientes

get/api/v1/clients
clients:read
Parámetros de consulta
searchstringopcional
Búsqueda de texto libre sobre el nombre comercial, el sector o el correo del contacto principal del cliente (sin distinguir mayúsculas, coincidencias parciales permitidas).
statusarray of string (complete | draft)opcional
Restringir a uno o más estados: complete (activo, totalmente incorporado) o draft (aún en configuración).
representativeIdsarray of stringopcional
Restringir a clientes asignados a uno o más de estos ID de miembros del equipo — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
goalsarray of string (improve_rankings | get_reviews | fix_listings)opcional
Restringir a uno o más objetivos principales del cliente: improve_rankings, get_reviews o fix_listings.
healthMinnumberopcional
Puntuación de salud mínima a incluir, 0–100.
healthMaxnumberopcional
Puntuación de salud máxima a incluir, 0–100.
locationsMinnumberopcional
Número mínimo de ubicaciones que debe tener un cliente para incluirse.
locationsMaxnumberopcional
Número máximo de ubicaciones que puede tener un cliente y seguir incluyéndose.
createdAfterstringopcional
Solo clientes creados en esta fecha o después.
createdBeforestringopcional
Solo clientes creados en esta fecha o antes.
cursorstringopcional
Cursor de paginación del nextCursor de una respuesta anterior. Déjelo vacío para la primera página.
limitintegeropcional
Clientes a devolver por página, 1–200. El valor por defecto es 50.
Respuesta
dataobjectopcional
clientsarray of objectopcional
Los clientes que coinciden con esta página.
idstringopcional
Identificador único del cliente.
businessNamestringopcional
El nombre comercial del cliente.
industrystringopcional
El sector del cliente.
statusstring (complete | draft)opcional
Estado de incorporación: complete (activo) o draft.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente, o null.
healthScorenumberopcional
Una puntuación de 0 a 100 que resume la salud de la cuenta del cliente, o null si aún no se ha calculado.
locationCountnumberopcional
Número de ubicaciones que tiene este cliente, o null si se desconoce.
googleRatingnumberopcional
La calificación actual en estrellas de Google del cliente, o null.
googleReviewCountnumberopcional
El número actual de reseñas de Google del cliente, o null.
planNamestringopcional
Nombre del plan de este cliente, si tiene uno.
createdAtstringopcional
Fecha de creación del cliente, como marca de tiempo ISO 8601.
archivedbooleanopcional
Si el cliente está archivado.
archivedAtstringopcional
Fecha en que se archivó el cliente, como marca de tiempo ISO 8601, o null.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
primaryRepresentativeobjectopcional
El miembro del equipo responsable de este cliente, o null.
idstringopcional
firstNamestringopcional
lastNamestringopcional
emailstringopcional
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalnumberopcional
Número total de clientes que coinciden con los filtros, en todas las páginas.
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/clients
Su clave de API
search
status
representativeIds
goals
healthMin
healthMax
locationsMin
locationsMax
createdAfter
createdBefore
cursor
limit
{
  "data": {
    "clients": [
      {
        "id": "cli_123",
        "businessName": "Acme Dental",
        "industry": "Dental",
        "status": "complete",
        "goal": "get_reviews",
        "healthScore": 82,
        "locationCount": 1,
        "googleRating": 4.8,
        "googleReviewCount": 26,
        "archived": false,
        "archivedAt": null,
        "scheduledArchiveAt": null,
        "packageType": null,
        "planName": null,
        "createdAt": "2026-01-15T10:00:00.000Z",
        "primaryRepresentative": {
          "id": "usr_123",
          "firstName": "Jamie",
          "lastName": "Lee",
          "email": "jamie@youragency.com"
        }
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Recursos/Clients/postCrear un cliente

Crea un nuevo cliente en su agencia, además de una primera ubicación cuando los datos de dirección corresponden a un lugar real.

Crear un cliente

post/api/v1/clients
clients:write
Cuerpo de la solicitud
businessNamestringobligatorio
El nombre comercial del nuevo cliente.
primaryContactEmailstringobligatorio
Correo electrónico del contacto principal del cliente.
primaryRepresentativeIdstringobligatorio
ID del miembro del equipo responsable de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
websitestringopcional
La URL del sitio web del cliente.
industrystringopcional
El sector del cliente.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente: improve_rankings, get_reviews o fix_listings.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente.
placeIdstringopcional
El Place ID de Google del cliente, de la API de Places de Google — Synup no ofrece una búsqueda de lugares propia. También crea la primera ubicación del cliente — no haga a continuación una creación de ubicación aparte para el mismo negocio.
latitudenumberopcional
La latitud de la ubicación del cliente. Necesaria junto con placeId y longitude para rastrear también una palabra clave.
longitudenumberopcional
La longitud de la ubicación del cliente.
googleRatingnumberopcional
La calificación actual en estrellas de Google del cliente, si se conoce.
googleReviewCountnumberopcional
El número actual de reseñas de Google del cliente, si se conoce.
trackingKeywordstringopcional
Una palabra clave para rastrear el posicionamiento local del cliente. Requiere que placeId, latitude y longitude también estén establecidos.
clientPlanIdstringopcional
Qué plan de portal de clientes asignar. Por defecto, el plan predeterminado de su agencia. No hay un endpoint que liste los planes — obtenga un ID válido del clientPlan.id de un cliente existente o de la configuración de planes de su agencia en Synup.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
Respuesta
dataobjectopcional
clientobjectopcional
Puede haber campos internos adicionales que no forman parte del contrato estable — dependa únicamente de los campos documentados aquí.
idstringopcional
Identificador único del cliente.
businessNamestringopcional
El nombre comercial del cliente.
websitestringopcional
La URL del sitio web del cliente.
industrystringopcional
El sector del cliente.
primaryContactEmailstringopcional
Correo electrónico del contacto principal del cliente.
primaryRepresentativeIdstringopcional
ID del miembro del equipo responsable de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
visibilitystring (public | private)opcional
Si el cliente es public o private dentro de su agencia.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente, o null.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente, o null.
trackingKeywordstringopcional
Una palabra clave rastreada para el posicionamiento local de este cliente, o null.
healthScorenumberopcional
Una puntuación de 0 a 100 que resume la salud de la cuenta del cliente, o null si aún no se ha calculado.
planNamestringopcional
Nombre del plan de este cliente, si tiene uno.
archivedbooleanopcional
Si el cliente está archivado.
archivedAtstringopcional
Fecha en que se archivó el cliente, como marca de tiempo ISO 8601, o null.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
createdAtstringopcional
Fecha de creación del cliente, como marca de tiempo ISO 8601.
updatedAtstringopcional
Fecha de la última actualización del cliente, como marca de tiempo ISO 8601.
locationIdstringopcional
ID de la primera ubicación creada junto con este cliente, o null si aún no se pudo crear ninguna.
locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)opcional
Por qué no se creó ninguna primera ubicación, cuando se proporcionó un placeId pero no resultó ninguna ubicación — por ejemplo, location_limit significa que la agencia alcanzó el límite de ubicaciones de su plan. Null cuando no aplica.
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.
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/clients
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "client": {
      "id": "cli_123",
      "businessName": "Acme Dental",
      "website": null,
      "industry": null,
      "primaryContactEmail": "owner@acmedental.com",
      "primaryRepresentativeId": "usr_123",
      "visibility": "public",
      "goal": null,
      "notes": null,
      "gbpLink": null,
      "trackingKeyword": null,
      "healthScore": null,
      "planName": null,
      "archived": false,
      "archivedAt": null,
      "scheduledArchiveAt": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    "locationId": "loc_456",
    "locationSkipped": null
  }
}
v1Recursos/Clients/getObtener un cliente

Devuelve todos los detalles de un cliente: perfil de negocio, representante asignado, creador, puntuación de salud y plan.

Obtener un cliente

get/api/v1/clients/{id}
clients:read
Parámetros de consulta
idstringobligatorio
El cliente a consultar.
Respuesta
dataobjectopcional
Todo lo de Client, además de los objetos resueltos de representante, creador y plan.
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/clients/{id}
Su clave de API
id *
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z",
    "primaryRepresentative": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "createdBy": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "clientPlan": null
  }
}
v1Recursos/Clients/patchActualizar un cliente

Edita los campos editables de un cliente existente. Envíe solo los campos que desea cambiar. El primaryContactEmail del cliente (su acceso al portal) solo puede establecerse aquí mientras esté vacío — nunca puede cambiarse una vez establecido.

Actualizar un cliente

patch/api/v1/clients/{id}
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a actualizar.
Cuerpo de la solicitud
businessNamestringopcional
El nombre comercial del nuevo cliente.
industrystringopcional
El sector del cliente.
websitestringopcional
La URL del sitio web del cliente.
primaryContactNamestringopcional
El nombre del contacto principal.
phonestringopcional
El número de teléfono del cliente.
locationCountnumberopcional
El número de ubicaciones declarado por el cliente — solo informativo, no el número real de ubicaciones creadas.
citystringopcional
La ciudad del cliente.
phoneCountryCodestringopcional
El país en código ISO-3166-1 alfa-2 al que pertenece el número de teléfono del cliente (p. ej. "US", "IN") — la región, no el prefijo telefónico.
countrystringopcional
El país del cliente, como código ISO-3166-1 alfa-2.
statestringopcional
El estado, provincia o región del cliente.
trackingKeywordstringopcional
Una palabra clave para rastrear el posicionamiento local del cliente.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente.
packageTypestringopcional
El tipo de paquete del cliente.
clientPlanIdstringopcional
Qué plan de portal de clientes asignar. Por defecto, el plan predeterminado de su agencia. No hay un endpoint que liste los planes — obtenga un ID válido del clientPlan.id de un cliente existente o de la configuración de planes de su agencia en Synup.
primaryRepresentativeIdstringopcional
El ID de usuario del miembro del equipo propietario de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
visibilitystring (public | private)opcional
Si el cliente es public o private dentro de su agencia.
primaryContactEmailstringopcional
Correo electrónico del contacto principal del cliente. Solo se puede establecer mientras esté vacío — se convierte en el acceso al portal y nunca puede cambiarse una vez establecido.
Respuesta
dataobjectopcional
Puede haber campos internos adicionales que no forman parte del contrato estable — dependa únicamente de los campos documentados aquí.
idstringopcional
Identificador único del cliente.
businessNamestringopcional
El nombre comercial del cliente.
websitestringopcional
La URL del sitio web del cliente.
industrystringopcional
El sector del cliente.
primaryContactEmailstringopcional
Correo electrónico del contacto principal del cliente.
primaryRepresentativeIdstringopcional
ID del miembro del equipo responsable de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
visibilitystring (public | private)opcional
Si el cliente es public o private dentro de su agencia.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente, o null.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente, o null.
trackingKeywordstringopcional
Una palabra clave rastreada para el posicionamiento local de este cliente, o null.
healthScorenumberopcional
Una puntuación de 0 a 100 que resume la salud de la cuenta del cliente, o null si aún no se ha calculado.
planNamestringopcional
Nombre del plan de este cliente, si tiene uno.
archivedbooleanopcional
Si el cliente está archivado.
archivedAtstringopcional
Fecha en que se archivó el cliente, como marca de tiempo ISO 8601, o null.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
createdAtstringopcional
Fecha de creación del cliente, como marca de tiempo ISO 8601.
updatedAtstringopcional
Fecha de la última actualización del cliente, como marca de tiempo ISO 8601.
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/clients/{id}
Su clave de API
id *
Cuerpo de la solicitud
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T09:30:00.000Z"
  }
}
v1Recursos/Clients/deleteArchivar un cliente

Solicita el archivado de un cliente — esta API nunca lo elimina de forma permanente. Si el cliente tiene alguna ubicación, esto lo PROGRAMA: el cliente y todas sus ubicaciones se archivan al final del periodo de facturación actual, y hasta entonces todo permanece totalmente activo y facturado — el archivado puede cancelarse con el endpoint cancel-archive. Un cliente sin ninguna ubicación se archiva de inmediato en su lugar (no hay nada que diferir). El campo outcome de la respuesta indica cuál de los dos ocurrió realmente.

Archivar un cliente

delete/api/v1/clients/{id}
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a archivar.
Respuesta
dataobjectopcional
Los campos presentes dependen de outcome: scheduled incluye scheduledArchiveAt/archiveAt/locationCount; archived incluye locationsArchived/locationsFailed/cancelledScheduledPosts.
outcomestring (scheduled | archived)obligatorio
Lo que realmente ocurrió: archived (inmediato — no existían ubicaciones, o ninguna estaba activa) o scheduled (se archiva al final del periodo de facturación).
clientIdstringobligatorio
Identificador único del cliente.
businessNamestringobligatorio
El nombre comercial del cliente.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
archiveAtstringopcional
Cuándo se producirá realmente el archivado programado — el límite de facturación de la agencia. Null si la agencia no tiene ninguno. Presente solo cuando outcome es scheduled.
locationCountnumberopcional
Número de ubicaciones que tiene este cliente, o null si se desconoce.
locationsArchivednumberopcional
Número de ubicaciones archivadas junto con el cliente. Presente solo cuando outcome es archived.
locationsFailednumberopcional
Número de ubicaciones cuyo archivado falló. Presente solo cuando outcome es archived.
cancelledScheduledPostsnumberopcional
Número de publicaciones programadas canceladas como parte del archivado. Presente solo cuando outcome es archived.
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.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/clients/{id}
Su clave de API
id *
{
  "data": {
    "outcome": "scheduled",
    "clientId": "cli_123",
    "businessName": "Acme Dental",
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z",
    "locationCount": 1
  }
}
v1Recursos/Clients/postCancelar un archivado programado

Cancela un archivado de cliente pendiente, de modo que un cliente programado para archivarse al final del periodo de facturación continúe con normalidad. También libera las ubicaciones que estaban programadas junto con él. Solo funciona mientras el archivado esté aún pendiente — un cliente ya archivado por completo debe reactivarse en su lugar, mediante el endpoint reactivate.

Cancelar un archivado programado

post/api/v1/clients/{id}/cancel-archive
clients:write
Parámetros de consulta
idstringobligatorio
El cliente cuyo archivado pendiente debe cancelarse.
Respuesta
dataobjectopcional
cancelledbooleanopcional
Siempre true en caso de éxito.
locationsReleasednumberopcional
Número de ubicaciones liberadas del programa de archivado cancelado.
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.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/clients/{id}/cancel-archive
Su clave de API
id *
{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}
v1Recursos/Clients/postEnviar la invitación al portal del cliente

Envía (o reenvía) el correo de invitación al portal de clientes al contacto principal de un cliente — un enlace mágico sin contraseña. Reenviarlo invalida cualquier enlace enviado previamente. Falla si el cliente no tiene un primaryContactEmail configurado.

Enviar la invitación al portal del cliente

post/api/v1/clients/{id}/invite
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a invitar.
Respuesta
dataobjectopcional
portalLinkstringopcional
La URL del enlace mágico enviado en el correo de invitación.
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.
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/clients/{id}/invite
Su clave de API
id *
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}
v1Recursos/Clients/postReactivar un cliente archivado

Restaura un cliente ya archivado, y todas las ubicaciones que se archivaron junto con él. Un cliente que no está archivado actualmente es un éxito sin efecto, no un error. Esta es la única forma de revertir un cliente con outcome archived — uno que todavía esté programado debe pasar por cancel-archive en su lugar.

Reactivar un cliente archivado

post/api/v1/clients/{id}/reactivate
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a reactivar.
Respuesta
dataobjectopcional
archivedbooleanopcional
Si el cliente está archivado.
locationsArchivednumberopcional
Número de ubicaciones archivadas junto con el cliente. Presente solo cuando outcome es archived.
locationsFailednumberopcional
Número de ubicaciones cuyo archivado falló. Presente solo cuando outcome es archived.
cancelledScheduledPostsnumberopcional
Número de publicaciones programadas canceladas como parte del archivado. Presente solo cuando outcome es archived.
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/clients/{id}/reactivate
Su clave de API
id *
{
  "data": {
    "archived": false,
    "locationsArchived": 1,
    "locationsFailed": 0,
    "cancelledScheduledPosts": 0
  }
}
v1Recursos/Clients/getObtener resumen del cliente

Devuelve una instantánea consolidada de un cliente: estadísticas agregadas de ubicaciones, reseñas y SEO.

Obtener resumen del cliente

get/api/v1/clients/summary
clients:read
Parámetros de consulta
clientIdstringobligatorio
El cliente a resumir.
Respuesta
dataobjectopcional
locationsobjectopcional
Estadísticas agregadas de ubicaciones de este cliente.
reviewsobjectopcional
Estadísticas agregadas de reseñas de este cliente.
seoobjectopcional
Estadísticas agregadas de posicionamiento SEO de este cliente.
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/clients/summary
Su clave de API
clientId *
{
  "data": {
    "locations": {
      "total": 1,
      "byStatus": {
        "approved": 1
      },
      "byVerification": {
        "unknown": 1
      }
    },
    "reviews": {
      "avgRating": 4.8,
      "total": 26
    },
    "seo": {
      "avgRank": 3.2,
      "top3Pct": 0.62
    }
  }
}