Synupv1
Criar chave
v1Recursos/Reviews

Reviews

Consulte e responda às avaliações de clientes de um local.

Retorna avaliações de um local. Tanto locationId quanto clientId são obrigatórios.

Listar avaliações

get/api/v1/reviews
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringobrigatório
O cliente do local.
sitesstringopcional
Plataformas de avaliação a incluir, separadas por vírgula (ex. google,facebook).
ratingsstringopcional
Classificações em estrelas a incluir, separadas por vírgula (ex. 1,2).
sentimentstringopcional
Sentimentos a incluir, separados por vírgula (positive, neutral, negative).
statusstring (responded | unreplied)opcional
Filtrar por status de resposta: responded ou unreplied.
keywordstringopcional
Busca de texto livre no corpo da avaliação e no autor.
fromstringopcional
Início da janela (data ISO).
tostringopcional
Fim da janela (data ISO).
sortstring (newest | oldest | lowest | highest)opcional
Ordem: newest, oldest, lowest ou highest.
deletedstring (1)opcional
Passe 1 para mostrar avaliações removidas/ausentes em vez das ativas.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior.
limitintegeropcional
Avaliações por página, 1-100. Padrão 30.
Resposta
dataobjectopcional
foundbooleanopcional
Se o local foi encontrado e estava acessível para esta chave.
reviewsarray of objectopcional
As avaliações em si.
idstringopcional
Identificador único da avaliação.
authorstringopcional
Nome de quem avaliou, ou null se não informado pela fonte.
ratingnumberopcional
Classificação em estrelas, ou null.
bodystringopcional
O texto da avaliação.
reviewDatestringopcional
Data de publicação da avaliação, como timestamp ISO 8601, ou null.
platformstringopcional
Plataforma de origem, ex.: google, facebook.
platformLabelstringopcional
Nome de exibição da plataforma de origem, ou null.
sentimentstringopcional
Sentimento detectado da avaliação, ou null.
replyobjectopcional
A resposta da empresa, se houver, ou null.
authorstringopcional
bodystringopcional
datestringopcional
reviewUrlstringopcional
Link para a avaliação na plataforma de origem, ou null.
respondablebooleanopcional
Se ainda é possível publicar uma resposta a esta avaliação.
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalnumberopcional
Número total de avaliações que correspondem à solicitação.
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/reviews
Sua chave 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/getObter resumo de avaliações

Retorna um resumo consolidado de avaliações de toda a sua agência (ou de um cliente) — distribuição de notas, volume e tendência no período selecionado.

Obter resumo de avaliações

get/api/v1/reviews/summary
reviews:read
Parâmetros de consulta
clientIdstringopcional
Limita às avaliações de um cliente. Se omitido, resume todas as avaliações que sua chave pode ver.
tagsstringopcional
Limita a localizações com qualquer uma destas tags internas separadas por vírgula.
fromstringopcional
Início do intervalo de datas (inclusivo), no formato AAAA-MM-DD. Por padrão, uma janela recente contínua.
tostringopcional
Fim do intervalo de datas (inclusivo), no formato AAAA-MM-DD. Por padrão, hoje.
Resposta
dataobjectopcional
O resumo consolidado — distribuição de notas, volume de avaliações e dados de tendência para o período selecionado.
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/reviews/summary
Sua chave de API
clientId
tags
from
to
{}
v1Recursos/Reviews/getListar fontes de avaliações

Cada fonte de avaliações de um local — plataformas conectadas (Google, Facebook, ...) mais URLs personalizadas (Yelp, TripAdvisor, ...), com status e estado de ocultação.

Listar fontes de avaliações

get/api/v1/reviews/sources
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
O local a consultar.
clientIdstringobrigatório
O cliente do local.
Resposta
dataobjectopcional
sourcesarray of objectopcional
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/sources
Sua chave de API
locationId *
clientId *
{}
v1Recursos/Reviews/postAdicionar uma fonte de avaliação personalizada

Adiciona uma URL de página de avaliações personalizada (Yelp, TripAdvisor, Trustpilot ou qualquer página de avaliações de empresa) como fonte para este local. A plataforma é detectada automaticamente a partir da URL. Não valida a URL em tempo real antes de adicionar — uma URL inválida aparece depois como uma raspagem falhada.

Adicionar uma fonte de avaliação personalizada

post/api/v1/reviews/sources
reviews:write
Corpo da solicitação
locationIdstringobrigatório
clientIdstringobrigatório
urlstringobrigatório
A URL da página de avaliações a adicionar.
Resposta
dataobjectopcional
idstringopcional
O id da fonte personalizada recém-criada.
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.
409Esta URL já é uma fonte para este local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/sources
Sua chave de API
Corpo da solicitação*
{}
v1Recursos/Reviews/patchAtualizar uma fonte de avaliação

Ocultar/exibir uma fonte (plataforma automática ou personalizada), ou alterar o intervalo de busca de uma fonte personalizada.

Atualizar uma fonte de avaliação

patch/api/v1/reviews/sources/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
A chave da fonte — um slug de plataforma automática (ex. "google") ou o id de uma fonte personalizada.
Corpo da solicitação
typestring (auto | custom)obrigatório
locationIdstringobrigatório
clientIdstringobrigatório
hidebooleanopcional
Defina true para ocultar esta fonte da visualização de avaliações, false para exibir.
fetchIntervalHoursintegeropcional
Novo intervalo de raspagem em horas. Apenas fontes personalizadas.
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/reviews/sources/{id}
Sua chave de API
id *
Corpo da solicitação*
{}
v1Recursos/Reviews/deleteRemover uma fonte de avaliação personalizada

Remove permanentemente uma fonte de avaliação personalizada e para de raspá-la.

Remover uma fonte de avaliação personalizada

delete/api/v1/reviews/sources/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
locationIdstringobrigatório
clientIdstringobrigatório
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
delete/api/v1/reviews/sources/{id}
Sua chave de API
id *
locationId *
clientId *
{}
v1Recursos/Reviews/postTentar novamente uma fonte de avaliação travada/falhada

Redefine o estado de falha de uma fonte personalizada e a coloca de volta na fila para uma raspagem imediata.

Tentar novamente uma fonte de avaliação travada/falhada

post/api/v1/reviews/sources/{id}/retry
reviews:write
Parâmetros de consulta
idstringobrigatório
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/reviews/sources/{id}/retry
Sua chave de API
id *
{}
v1Recursos/Reviews/getObter análise de avaliações

KPIs (com variações período a período), uma tendência mensal (volume, avaliação, mix de sentimento, taxa de resposta), distribuição de avaliações, detalhamento por plataforma, horários por dia da semana, um benchmark da agência, temas e um resumo de IA — para um local.

Obter análise de avaliações

get/api/v1/reviews/analytics
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
O local a consultar.
clientIdstringobrigatório
O cliente do local.
kpiDaysinteger (7 | 30 | 90)opcional
Janela de KPI em dias: 7, 30 ou 90. Padrão 30.
trendMonthsinteger (3 | 6 | 12)opcional
Duração da tendência em meses: 3, 6 ou 12. Padrão 6.
Resposta
dataobjectopcional
O payload completo de Análise de Avaliações.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/analytics
Sua chave de API
locationId *
clientId *
kpiDays
trendMonths
{}
v1Recursos/Reviews/getObter um resumo de análise de avaliações

Análise de avaliações agregada nos locais deste cliente (ou de toda a agência): contagem, avaliação média, distribuição de avaliações, mix de sentimento, taxa de resposta, detalhamento por plataforma e uma tendência mensal. Limite o escopo com tags.

Obter um resumo de análise de avaliações

get/api/v1/reviews/analytics/summary
reviews:read
Parâmetros de consulta
clientIdstringopcional
Limitar aos locais de um cliente.
tagsstringopcional
Nomes de tags de local separados por vírgula — apenas locais com pelo menos uma dessas tags são incluídos.
monthsintegeropcional
Duração da tendência em meses. Padrão 6.
Resposta
dataobjectopcional
locationsnumberopcional
Número de locais no escopo.
countnumberopcional
Total de avaliações no escopo.
avgRatingnumberopcional
Avaliação média no escopo.
distributionobjectopcional
Contagem de avaliações por classificação em estrelas (1-5).
sentimentobjectopcional
Contagem de avaliações por sentimento.
positivenumberopcional
neutralnumberopcional
negativenumberopcional
responseRatenumberopcional
Percentual de avaliações com resposta.
byPlatformarray of objectopcional
Contagem e avaliação média por plataforma.
platformstringopcional
countnumberopcional
avgRatingnumberopcional
trendarray of objectopcional
Contagem mensal e avaliação média.
monthstringopcional
countnumberopcional
avgRatingnumberopcional
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/reviews/analytics/summary
Sua chave de API
clientId
tags
months
{}
v1Recursos/Reviews/getListar concorrentes rastreados

Os concorrentes rastreados para um local.

Listar concorrentes 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
Resposta
dataobjectopcional
competitorsarray of objectopcional
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/competitors
Sua chave de API
locationId
clientId
{}
v1Recursos/Reviews/postAdicionar um concorrente

Começa a rastrear um concorrente pelo nome para um local.

Adicionar um concorrente

post/api/v1/reviews/competitors
reviews:write
Corpo da solicitação
locationIdstringopcional
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.competitors.post.paramsClientId
namestringobrigatório
O nome comercial do concorrente.
Resposta
dataobjectopcional
competitorobjectopcional
Linha de perfil de um concorrente (id, nome, origem, fixado, etc.).
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/competitors
Sua chave de API
Corpo da solicitação*
{}
v1Recursos/Reviews/getObter análise competitiva de avaliações

Compara as avaliações de um local com seus concorrentes rastreados: placar, pontos fortes/lacunas, e velocidade de avaliações + share of voice.

Obter análise competitiva de avaliações

get/api/v1/reviews/competitors/analysis
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
clientIdstringobrigatório
Resposta
dataobjectopcional
O payload completo da análise competitiva (placar, pontos fortes/lacunas, velocidade).
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/competitors/analysis
Sua chave de API
locationId *
clientId *
{}
v1Recursos/Reviews/deleteRemover um concorrente rastreado

Para permanentemente de rastrear um concorrente pelo id.

Remover um concorrente rastreado

delete/api/v1/reviews/competitors/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
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.
delete/api/v1/reviews/competitors/{id}
Sua chave de API
id *
{}
v1Recursos/Reviews/postAtualizar as avaliações de um concorrente

Raspa novamente as avaliações do Google de um concorrente rastreado.

Atualizar as avaliações de um concorrente

post/api/v1/reviews/competitors/{id}/refresh
reviews:write
Parâmetros de consulta
idstringobrigatório
Resposta
dataobjectopcional
okbooleanopcional
notestringopcional
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/reviews/competitors/{id}/refresh
Sua chave 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
Corpo da solicitação
clientIdstringobrigatório
apiDocs.resources.reviews.competitorsRefresh.paramsClientId
Resposta
dataobjectopcional
okbooleanopcional
queuedbooleanopcional
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.
post/api/v1/reviews/competitors/refresh
Sua chave de API
Corpo da solicitação*
{}
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
reviewIdstringobrigatório
apiDocs.resources.reviews.notes.get.paramsReviewId
Resposta
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
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/notes
Sua chave 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
Corpo da solicitação
reviewIdstringobrigatório
apiDocs.resources.reviews.notes.post.paramsReviewId
bodystringobrigatório
apiDocs.resources.reviews.notes.post.paramsBody
Resposta
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
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/notes
Sua chave de API
Corpo da solicitação*
{}
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
reviewIdstringobrigatório
apiDocs.resources.reviews.notes.delete.paramsReviewId
noteIdstringobrigatório
apiDocs.resources.reviews.notes.delete.paramsNoteId
Resposta
dataobjectopcional
deletedbooleanopcional
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.
delete/api/v1/reviews/notes
Sua chave 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
Corpo da solicitação
locationIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobrigatório
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Resposta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
queuedbooleanopcional
notestringopcional
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/topic-trends/keywords
Sua chave de API
Corpo da solicitação*
{}
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
keywordstringobrigatório
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Resposta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
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.
delete/api/v1/reviews/topic-trends/keywords
Sua chave 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
Corpo da solicitação
locationIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringopcional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobrigatório
apiDocs.resources.reviews.topicKeywords.paramsKeyword
hidebooleanobrigatório
apiDocs.resources.reviews.topicKeywords.paramsHide
Resposta
dataobjectopcional
customarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
hiddenarray of stringopcional
apiDocs.resources.reviews.topicKeywords.fieldsHidden
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.
patch/api/v1/reviews/topic-trends/keywords
Sua chave de API
Corpo da solicitação*
{}
v1Recursos/Reviews/getObter tendências de tópicos

Uma série temporal agrupada por tópico de avaliação, um ranking, movimentos ascendentes/descendentes, e tópicos emergentes/em declínio — para um local.

Obter tendências de tópicos

get/api/v1/reviews/topic-trends
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
clientIdstringobrigatório
windowDaysinteger (30 | 90 | 180)opcional
Janela de tendência em dias: 30, 90 ou 180. Padrão 90.
Resposta
dataobjectopcional
O payload completo de Tendências de Tópicos.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/topic-trends
Sua chave de API
locationId *
clientId *
windowDays
{}
v1Recursos/Reviews/getObter uma série mensal mais longa de um tópico

Uma série mês a mês mais longa para tópicos, além da janela de tendência padrão.

Obter uma série mensal mais longa de um tópico

get/api/v1/reviews/topic-trends/series
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
clientIdstringobrigatório
monthsintegeropcional
Duração da série em meses. Padrão 12.
Resposta
dataobjectopcional
O payload completo da série mensal de tópicos.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/topic-trends/series
Sua chave de API
locationId *
clientId *
months
{}
v1Recursos/Reviews/getObter avaliações que mencionam um tópico

Aprofunde-se nas avaliações que mencionam um tópico, opcionalmente restrito a um mês.

Obter avaliações que mencionam um tópico

get/api/v1/reviews/topic-trends/reviews
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
clientIdstringobrigatório
topicstringobrigatório
O tópico a consultar (de GET /api/v1/reviews/topic-trends).
monthstringopcional
Restringir a uma célula do mapa de calor (AAAA-MM). Omita para o histórico completo.
limitintegeropcional
Máximo de avaliações a retornar.
Resposta
dataobjectopcional
reviewsarray of objectopcional
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/topic-trends/reviews
Sua chave de API
locationId *
clientId *
topic *
month
limit
{}
v1Recursos/Reviews/getListar widgets de avaliações

Cada widget de avaliações configurado para um local.

Listar widgets de avaliações

get/api/v1/reviews/widgets
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
clientIdstringobrigatório
Resposta
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
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/widgets
Sua chave de API
locationId *
clientId *
{}
v1Recursos/Reviews/postCriar um widget de avaliações

Cria um novo widget de avaliações incorporável (selo de classificação + carrossel/lista de avaliações) para um local.

Criar um widget de avaliações

post/api/v1/reviews/widgets
reviews:write
Corpo da solicitação
locationIdstringobrigatório
clientIdstringobrigatório
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstring (30d | 90d | 1y | all)opcional
countintegeropcional
includeInternalbooleanopcional
layoutstringopcional
statusstring (draft | published)opcional
Resposta
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
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/widgets
Sua chave de API
Corpo da solicitação*
{}
v1Recursos/Reviews/getObter um widget de avaliações

Retorna a configuração completa de um widget de avaliações.

Obter um widget de avaliações

get/api/v1/reviews/widgets/{id}
reviews:read
Parâmetros de consulta
idstringobrigatório
Resposta
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
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/reviews/widgets/{id}
Sua chave de API
id *
{}
v1Recursos/Reviews/patchAtualizar um widget de avaliações

Atualiza a configuração ou o design de um widget (ou o publica, via status).

Atualizar um widget de avaliações

patch/api/v1/reviews/widgets/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
Corpo da solicitação
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
Resposta
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
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.
patch/api/v1/reviews/widgets/{id}
Sua chave de API
id *
Corpo da solicitação
{}
v1Recursos/Reviews/deleteExcluir um widget de avaliações

Exclui permanentemente um widget de avaliações. O widget incorporado público para de funcionar depois de excluído.

Excluir um widget de avaliações

delete/api/v1/reviews/widgets/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
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.
delete/api/v1/reviews/widgets/{id}
Sua chave de API
id *
{}
v1Recursos/Reviews/postResponder a uma avaliação

Publica uma resposta da empresa a uma avaliação e a envia à plataforma de origem. Falha com um erro de regra de negócio (422) se a avaliação não puder ser respondida — ex.: porque foi removida de sua fonte.

Responder a uma avaliação

post/api/v1/reviews/reply
reviews:write
Corpo da solicitação
reviewIdstringobrigatório
A avaliação a ser respondida. Obrigatório.
textstringobrigatório
O texto da resposta a ser publicada. Obrigatório.
Resposta
dataobjectopcional
okbooleanopcional
Se a resposta foi aceita.
pushedbooleanopcional
Se a resposta foi realmente enviada à plataforma de origem (em vez de apenas colocada na fila).
statusstring (posted | pending | failed | draft)opcional
Um de: posted, pending, failed, draft.
externalReplyIdstringopcional
O id da resposta na plataforma de origem, ou null.
retryablebooleanopcional
Se o envio falhou, se uma nova tentativa poderia ter sucesso — null quando não aplicável.
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.
post/api/v1/reviews/reply
Sua chave de API
Corpo da solicitação*
{}