VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Avaliações e comentários

Paginação e filtros

Parâmetros de consulta para paginar, ordenar e filtrar as avaliações e comentários devolvidos pela listagem de Discussions.

Use estes parâmetros de consulta na chamada de listagem (GET /api/2.0/discussions) para encontrar avaliações e comentários com propriedades específicas e exibi-los como você precisa. Uma loja pode ter milhares de entradas, então quase sempre você vai combinar a paginação com pelo menos um filtro.

Parâmetros de consulta

Paginação e ordenação

Parâmetros de consulta

pageintegerpadrão: 1
Mostra as avaliações e comentários da página de saída com o número informado.
items_per_pageintegerpadrão: 10
Quantidade de avaliações e comentários exibidos na página de saída.
sort_bystringpadrão: timestamp
nameip_addresstimestampstatus
Ordena as avaliações e comentários por este campo.
sort_orderstringpadrão: desc
ascdesc
Ordem crescente ou decrescente.

Filtros

Parâmetros de consulta

statusstring
AD
Filtra por status: A (ativo) ou D (desativado).
namestring
Filtra as avaliações e comentários por nome.
messagestring
Filtra as avaliações e comentários pelo conteúdo.
typestring
CRB
Filtra por tipo: C para comentários, R para avaliações, B para os dois.
ip_addressstring
Filtra as avaliações e comentários por endereço IP.
rating_valueinteger
Filtra as avaliações e comentários pela nota.
object_typestring
PCAOE
Filtra pelo objeto: P produto, C categoria, A página, O pedido, E página inicial.
object_idinteger
Filtra as avaliações e comentários pelo id do objeto.
periodstringpadrão: A
ADLDWLWMLMYLYHHHWHMC
Filtra por período de tempo. Os valores estão listados abaixo.
time_fromstring
Filtra pelo período informado: início do período. Use com period=C.
time_tostring
Filtra pelo período informado: fim do período. Use com period=C.

Valores de period

ValorPeríodo
ATodo o tempo
DHoje
LDDia anterior
WSemana atual
LWSemana anterior
MMês atual
LMÚltimo mês
YAno atual
LYÚltimo ano
HHÚltimas 24 horas
HWÚltimos 7 dias
HMÚltimos 30 dias
CPeríodo específico (use com time_from e time_to)
Dica

Você pode combinar vários parâmetros para criar filtros bem específicos. Por exemplo, combine object_type=P com rating_value=5 para encontrar todas as avaliações de 5 estrelas de produtos.

Nota

Na tabela da referência, o valor padrão impresso para status é desc, embora os valores possíveis que ela cita sejam A e D. A tabela não informa padrão para os demais filtros.

Exemplos

Paginação básica

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/discussions?items_per_page=20"

A resposta é um array com 20 avaliações e comentários da 1ª página.

Navegação entre páginas

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/discussions?page=5&items_per_page=20"

A resposta é um array com 20 avaliações da 5ª página de saída.

Avaliações de um produto

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/products/167/discussions"

A resposta é um array com as avaliações e comentários do produto com product_id=167.

Nota

Ao obter um grande número de avaliações, considere implementar paginação na sua aplicação para melhorar o desempenho e a experiência do usuário.

Anterior
Endpoints de Discussions
Próxima
Exemplos de Discussions
Nesta página
  • Parâmetros de consulta
  • Paginação e ordenação
  • Filtros
  • Valores de period
  • Exemplos
  • Paginação básica
  • Navegação entre páginas
  • Avaliações de um produto