Filtros e paginação
Como usar limit, offset e q sem se confundir
Visão rápida
Nesta API, a consulta segue esta lógica:
limitcontrola a quantidade por resposta;offsetcontrola de onde a página começa;qaplica filtros, ordenação ou combinações de condição.
Convenção de paginação desta V1
- o padrão operacional documentado é
100registros por página; - para ter previsibilidade, informe
limitexplicitamente; - na carga inicial, siga paginando até
hasMore = false; - na sincronização incremental, combine paginação com filtro temporal quando fizer sentido;
- o limite máximo permitido ainda não está publicado como contrato oficial.
Padrão recomendado
- teste o endpoint sem filtro;
- adicione
limiteoffsetse precisar controlar a paginação; - use
qsomente quando quiser restringir ou ordenar o retorno.
Exemplo sem filtro
Exemplo com paginação
Exemplo com filtro simples
Formato legível:
Formato pronto para URL:
Exemplo por ID
Formato legível:
Formato pronto para URL:
Exemplo com ordenação
Formato legível:
Formato pronto para URL:
Exemplo por período
Formato legível:
Formato pronto para URL:
Operadores úteis no q
$or$between$orderby$date$ne$lt$lte$gt$gte$instr$ninstr$notnull
Regras importantes
offsetelimitficam fora doq;- use os campos publicados naquele endpoint;
- use sempre o nome do campo exatamente como ele aparece no schema do endpoint;
- em clientes HTTP fora do Postman, o JSON de
qnormalmente precisa ser URL-encoded.
Erros comuns
- tentar usar no
qum campo que aquele endpoint não publica; - copiar um filtro de
pessoae usar igual emreceitaouvenda; - colocar
offsetelimitdentro do objeto JSON; - montar filtro complexo antes de testar a resposta base.