Parâmetros

Os parâmetros de requisição limitam os dados que um endpoint retorna. Todos os valores dos parâmetros de requisição devem ser codificados em URL.

Os parâmetros a seguir esperam valores em uma sintaxe especial. Para ver a lista completa de parâmetros obrigatórios e opcionais de cada endpoint, acesse a referência da API.

selecionar

Exemplo: field_a,field_b,field_c

Uma lista obrigatória de nomes de campo, separada por vírgulas. Isso define quais campos o endpoint deve retornar. Nem todos os endpoints aceitam este parâmetro.

Consulte o schema de resposta do endpoint na referência da API para ver a lista de nomes de campo válidos.

where

Exemplo: {"and":[{"field":"field_a","is":["gt",90]},{"field":"field_b","is":["eq","SEO"]}]}

Uma expressão de filtro para restringir os resultados. A sintaxe é descrita em detalhes em Sintaxe de filtro. Nem todos os endpoints aceitam este parâmetro.

Consulte a descrição do parâmetro do endpoint na referência da API para ver a lista de nomes de campo válidos que podem ser usados na expressão de filtro. Isso pode ser diferente da lista de nomes de campo do parâmetro select.

order_by

Exemplo: field_a:desc,field_b:asc

Ordena os resultados pelo(s) campo(s) e direção especificados (desc ou asc). Nem todos os endpoints aceitam este parâmetro.

Consulte o schema de resposta do endpoint na referência da API para ver a lista de nomes de campo válidos. Esta é a mesma lista de nomes de campo do parâmetro select.