v1Recursos/Clients

Clients

Crie, leia, atualize e arquive os clientes (empresas) da sua agência.

Retorna uma página dos clientes da sua agência, os mais recentes primeiro. Todos os filtros são opcionais e se combinam (um cliente precisa corresponder a todos); para avançar para mais resultados, envie novamente o nextCursor retornado.

Listar / buscar clientes

get/api/v1/clients

clients:read

Parâmetros de consulta

searchstringopcional

Busca por texto livre no nome comercial, setor ou e-mail do contato principal do cliente (sem diferenciar maiúsculas/minúsculas, correspondências parciais permitidas).

statusarray of string (complete | draft)opcional

Restringir a um ou mais status: complete (ativo, integração concluída) ou draft (ainda em configuração).

representativeIdsarray of stringopcional

Restringir a clientes atribuídos a um ou mais destes IDs de membros da equipe — consulte GET /api/v1/team/members para os IDs de membros da sua agência.

goalsarray of string (improve_rankings | get_reviews | fix_listings)opcional

Restringir a um ou mais objetivos principais do cliente: improve_rankings, get_reviews ou fix_listings.

healthMinnumberopcional

Menor pontuação de saúde a incluir, 0–100.

healthMaxnumberopcional

Maior pontuação de saúde a incluir, 0–100.

locationsMinnumberopcional

Número mínimo de locais que um cliente precisa ter para ser incluído.

locationsMaxnumberopcional

Número máximo de locais que um cliente pode ter e ainda ser incluído.

createdAfterstringopcional

Somente clientes criados nesta data ou depois.

createdBeforestringopcional

Somente clientes criados nesta data ou antes.

cursorstringopcional

Cursor de paginação do nextCursor de uma resposta anterior. Deixe vazio para a primeira página.

limitintegeropcional

Clientes a retornar por página, 1–200. O padrão é 50.

Resposta

dataobjectopcional

clientsarray of objectopcional

Os clientes que correspondem a esta página.

idstringopcional

Identificador único do cliente.

businessNamestringopcional

O nome comercial do cliente.

industrystringopcional

O setor de atuação do cliente.

statusstring (complete | draft)opcional

Status de integração: complete (ativo) ou draft.

goalstring (improve_rankings | get_reviews | fix_listings)opcional

O objetivo principal do cliente, ou null.

healthScorenumberopcional

Uma pontuação de 0 a 100 que resume a saúde da conta do cliente, ou null se ainda não calculada.

locationCountnumberopcional

Número de locais deste cliente, ou null se desconhecido.

googleRatingnumberopcional

A avaliação atual em estrelas do Google do cliente, ou null.

googleReviewCountnumberopcional

O número atual de avaliações do Google do cliente, ou null.

planNamestringopcional

Nome do plano deste cliente, se houver.

createdAtstringopcional

Data de criação do cliente, como timestamp ISO 8601.

archivedbooleanopcional

Se o cliente está arquivado.

archivedAtstringopcional

Data em que o cliente foi arquivado, como timestamp ISO 8601, ou null.

scheduledArchiveAtstringopcional

Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.

primaryRepresentativeobjectopcional

O membro da equipe responsável por este cliente, ou null.

idstringopcional

firstNamestringopcional

lastNamestringopcional

emailstringopcional

nextCursorstringopcional

Cursor de paginação para a próxima página, ou null quando não há mais resultados.

totalnumberopcional

Número total de clientes que correspondem aos filtros, em todas as páginas.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/clients

Sua chave 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/postCriar um cliente

Cria um novo cliente na sua agência, além de um primeiro local quando os dados de endereço correspondem a um lugar real.

Criar um cliente

post/api/v1/clients

clients:write

Corpo da solicitação

businessNamestringobrigatório

O nome comercial do novo cliente.

primaryContactEmailstringobrigatório

E-mail do contato principal do cliente.

primaryRepresentativeIdstringobrigatório

ID do membro da equipe responsável por este cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.

websitestringopcional

A URL do site do cliente.

industrystringopcional

O setor de atuação do cliente.

goalstring (improve_rankings | get_reviews | fix_listings)opcional

O objetivo principal do cliente: improve_rankings, get_reviews ou fix_listings.

gbpLinkstringopcional

A URL do perfil comercial do Google do cliente.

placeIdstringopcional

O Place ID do Google do cliente, da API Places do Google — o Synup não oferece uma busca de locais própria. Também cria o primeiro local do cliente — não faça em seguida uma criação de local separada para o mesmo negócio.

latitudenumberopcional

A latitude do local do cliente. Necessária junto com placeId e longitude para também monitorar uma palavra-chave.

longitudenumberopcional

A longitude do local do cliente.

googleRatingnumberopcional

A avaliação atual em estrelas do Google do cliente, se conhecida.

googleReviewCountnumberopcional

O número atual de avaliações do Google do cliente, se conhecido.

trackingKeywordstringopcional

Uma palavra-chave para monitorar o ranking de busca local do cliente. Requer que placeId, latitude e longitude também estejam definidos.

clientPlanIdstringopcional

Qual plano de portal do cliente atribuir. O padrão é o plano padrão da sua agência. Não há um endpoint que liste os planos — obtenha um ID válido a partir do clientPlan.id de um cliente existente, ou das configurações de plano da sua agência no Synup.

notesstringopcional

Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.

Resposta

dataobjectopcional

clientobjectopcional

Podem existir campos internos adicionais que não fazem parte do contrato estável — baseie-se apenas nos campos documentados aqui.

idstringopcional

Identificador único do cliente.

businessNamestringopcional

O nome comercial do cliente.

websitestringopcional

A URL do site do cliente.

industrystringopcional

O setor de atuação do cliente.

primaryContactEmailstringopcional

E-mail do contato principal do cliente.

primaryRepresentativeIdstringopcional

ID do membro da equipe responsável por este cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.

visibilitystring (public | private)opcional

Se o cliente é public ou private dentro da sua agência.

goalstring (improve_rankings | get_reviews | fix_listings)opcional

O objetivo principal do cliente, ou null.

notesstringopcional

Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.

gbpLinkstringopcional

A URL do perfil comercial do Google do cliente, ou null.

trackingKeywordstringopcional

Uma palavra-chave monitorada para o ranking de busca local deste cliente, ou null.

healthScorenumberopcional

Uma pontuação de 0 a 100 que resume a saúde da conta do cliente, ou null se ainda não calculada.

planNamestringopcional

Nome do plano deste cliente, se houver.

archivedbooleanopcional

Se o cliente está arquivado.

archivedAtstringopcional

Data em que o cliente foi arquivado, como timestamp ISO 8601, ou null.

scheduledArchiveAtstringopcional

Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.

createdAtstringopcional

Data de criação do cliente, como timestamp ISO 8601.

updatedAtstringopcional

Data da última atualização do cliente, como timestamp ISO 8601.

locationIdstringopcional

ID do primeiro local criado junto com este cliente, ou null se nenhum pôde ser criado ainda.

locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)opcional

Por que nenhum primeiro local foi criado, quando um placeId foi informado mas nenhum local resultou disso — por exemplo, location_limit significa que a agência atingiu o limite de locais do seu plano. Null quando não aplicável.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

post/api/v1/clients

Sua chave de API

Corpo da solicitação*

{
  "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/getObter um cliente

Retorna todos os detalhes de um cliente: perfil comercial, representante atribuído, criador, pontuação de saúde e plano.

Obter um cliente

get/api/v1/clients/{id}

clients:read

Parâmetros de consulta

idstringobrigatório

O cliente a consultar.

Resposta

dataobjectopcional

Tudo o que há em Client, além dos objetos resolvidos de representante, criador e plano.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/clients/{id}

Sua chave 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/patchAtualizar um cliente

Edita os campos editáveis de um cliente existente. Envie apenas os campos que deseja alterar. O primaryContactEmail do cliente (o login do portal) só pode ser definido aqui enquanto ainda estiver vazio — nunca pode ser alterado depois de definido.

Atualizar um cliente

patch/api/v1/clients/{id}

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente a atualizar.

Corpo da solicitação

businessNamestringopcional

O nome comercial do novo cliente.

industrystringopcional

O setor de atuação do cliente.

websitestringopcional

A URL do site do cliente.

primaryContactNamestringopcional

O nome do contato principal.

phonestringopcional

O número de telefone do cliente.

locationCountnumberopcional

O número de locais informado pelo cliente — apenas informativo, não o número real de locais criados.

citystringopcional

A cidade do cliente.

phoneCountryCodestringopcional

O país em código ISO-3166-1 alfa-2 ao qual o número de telefone do cliente pertence (por exemplo, "US", "IN") — a região, não o código de discagem.

countrystringopcional

O país do cliente, como código ISO-3166-1 alfa-2.

statestringopcional

O estado, província ou região do cliente.

trackingKeywordstringopcional

Uma palavra-chave para monitorar o ranking de busca local do cliente.

notesstringopcional

Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.

gbpLinkstringopcional

A URL do perfil comercial do Google do cliente.

packageTypestringopcional

O tipo de pacote do cliente.

clientPlanIdstringopcional

Qual plano de portal do cliente atribuir. O padrão é o plano padrão da sua agência. Não há um endpoint que liste os planos — obtenha um ID válido a partir do clientPlan.id de um cliente existente, ou das configurações de plano da sua agência no Synup.

primaryRepresentativeIdstringopcional

O ID de usuário do membro da equipe proprietário deste cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.

visibilitystring (public | private)opcional

Se o cliente é public ou private dentro da sua agência.

primaryContactEmailstringopcional

E-mail do contato principal do cliente. Só pode ser definido enquanto ainda estiver vazio — torna-se o login do portal e nunca pode ser alterado depois de definido.

Resposta

dataobjectopcional

Podem existir campos internos adicionais que não fazem parte do contrato estável — baseie-se apenas nos campos documentados aqui.

idstringopcional

Identificador único do cliente.

businessNamestringopcional

O nome comercial do cliente.

websitestringopcional

A URL do site do cliente.

industrystringopcional

O setor de atuação do cliente.

primaryContactEmailstringopcional

E-mail do contato principal do cliente.

primaryRepresentativeIdstringopcional

ID do membro da equipe responsável por este cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.

visibilitystring (public | private)opcional

Se o cliente é public ou private dentro da sua agência.

goalstring (improve_rankings | get_reviews | fix_listings)opcional

O objetivo principal do cliente, ou null.

notesstringopcional

Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.

gbpLinkstringopcional

A URL do perfil comercial do Google do cliente, ou null.

trackingKeywordstringopcional

Uma palavra-chave monitorada para o ranking de busca local deste cliente, ou null.

healthScorenumberopcional

Uma pontuação de 0 a 100 que resume a saúde da conta do cliente, ou null se ainda não calculada.

planNamestringopcional

Nome do plano deste cliente, se houver.

archivedbooleanopcional

Se o cliente está arquivado.

archivedAtstringopcional

Data em que o cliente foi arquivado, como timestamp ISO 8601, ou null.

scheduledArchiveAtstringopcional

Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.

createdAtstringopcional

Data de criação do cliente, como timestamp ISO 8601.

updatedAtstringopcional

Data da última atualização do cliente, como timestamp ISO 8601.

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

patch/api/v1/clients/{id}

Sua chave de API

id *

Corpo da solicitação

{
  "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/deleteArquivar um cliente

Solicita o arquivamento de um cliente — esta API nunca exclui um cliente permanentemente. Se o cliente tiver algum local, isso é AGENDADO: o cliente e todos os seus locais são arquivados no final do período de faturamento atual, e até então tudo permanece totalmente ativo e faturado — o arquivamento pode ser cancelado com o endpoint cancel-archive. Já um cliente sem nenhum local é arquivado imediatamente (não há nada a postergar). O campo outcome da resposta informa qual dos dois realmente aconteceu.

Arquivar um cliente

delete/api/v1/clients/{id}

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente a arquivar.

Resposta

dataobjectopcional

Quais campos estão presentes depende de outcome: scheduled traz scheduledArchiveAt/archiveAt/locationCount; archived traz locationsArchived/locationsFailed/cancelledScheduledPosts.

outcomestring (scheduled | archived)obrigatório

O que realmente aconteceu: archived (imediato — não existiam locais, ou nenhum estava ativo) ou scheduled (arquiva no final do período de faturamento).

clientIdstringobrigatório

Identificador único do cliente.

businessNamestringobrigatório

O nome comercial do cliente.

scheduledArchiveAtstringopcional

Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.

archiveAtstringopcional

Quando o arquivamento agendado realmente ocorrerá — o limite de faturamento da agência. Null se a agência não tiver nenhum. Presente apenas quando outcome é scheduled.

locationCountnumberopcional

Número de locais deste cliente, ou null se desconhecido.

locationsArchivednumberopcional

Número de locais arquivados junto com o cliente. Presente apenas quando outcome é archived.

locationsFailednumberopcional

Número de locais cujo arquivamento falhou. Presente apenas quando outcome é archived.

cancelledScheduledPostsnumberopcional

Número de publicações agendadas canceladas como parte do arquivamento. Presente apenas quando outcome é archived.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

delete/api/v1/clients/{id}

Sua chave 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 um arquivamento agendado

Cancela um arquivamento de cliente pendente, de modo que um cliente agendado para arquivar no final do período de faturamento continue normalmente. Também libera os locais que estavam agendados junto com ele. Só funciona enquanto o arquivamento ainda estiver pendente — um cliente já totalmente arquivado precisa ser reativado, através do endpoint reactivate.

Cancelar um arquivamento agendado

post/api/v1/clients/{id}/cancel-archive

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente cujo arquivamento pendente deve ser cancelado.

Resposta

dataobjectopcional

cancelledbooleanopcional

Sempre true em caso de sucesso.

locationsReleasednumberopcional

Número de locais liberados do agendamento de arquivamento cancelado.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

post/api/v1/clients/{id}/cancel-archive

Sua chave de API

id *

{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}

v1Recursos/Clients/postEnviar o convite do portal do cliente

Envia (ou reenvia) o e-mail de convite do portal do cliente ao contato principal de um cliente — um link mágico sem senha. Reenviar invalida qualquer link enviado anteriormente. Falha se o cliente não tiver um primaryContactEmail definido.

Enviar o convite do portal do cliente

post/api/v1/clients/{id}/invite

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente a convidar.

Resposta

dataobjectopcional

portalLinkstringopcional

A URL do link mágico enviado no e-mail de convite.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

post/api/v1/clients/{id}/invite

Sua chave de API

id *

{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

v1Recursos/Clients/postReativar um cliente arquivado

Restaura um cliente já arquivado, e todos os locais que foram arquivados junto com ele. Um cliente que não está arquivado no momento é um sucesso sem efeito (no-op), não um erro. Esta é a única forma de reverter um cliente com outcome archived — um que ainda esteja scheduled deve passar pelo cancel-archive em vez disso.

Reativar um cliente arquivado

post/api/v1/clients/{id}/reactivate

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente a reativar.

Resposta

dataobjectopcional

archivedbooleanopcional

Se o cliente está arquivado.

locationsArchivednumberopcional

Número de locais arquivados junto com o cliente. Presente apenas quando outcome é archived.

locationsFailednumberopcional

Número de locais cujo arquivamento falhou. Presente apenas quando outcome é archived.

cancelledScheduledPostsnumberopcional

Número de publicações agendadas canceladas como parte do arquivamento. Presente apenas quando outcome é archived.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

post/api/v1/clients/{id}/reactivate

Sua chave de API

id *

{
  "data": {
    "archived": false,
    "locationsArchived": 1,
    "locationsFailed": 0,
    "cancelledScheduledPosts": 0
  }
}

v1Recursos/Clients/getObter resumo do cliente

Retorna um retrato consolidado de um cliente: estatísticas agregadas de localizações, avaliações e SEO.

Obter resumo do cliente

get/api/v1/clients/summary

clients:read

Parâmetros de consulta

clientIdstringobrigatório

O cliente a resumir.

Resposta

dataobjectopcional

locationsobjectopcional

Estatísticas agregadas de localizações deste cliente.

reviewsobjectopcional

Estatísticas agregadas de avaliações deste cliente.

seoobjectopcional

Estatísticas agregadas de ranking de SEO deste cliente.

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/clients/summary

Sua chave 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
    }
  }
}