v1Recursos/Reviews/getObter resumo de avaliações

Obter 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.

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