Ordenação

Todos os endpoints de listagem aceitam um parâmetro de query string sort opcional, que define a ordem dos registros retornados.

Sintaxe

O parâmetro sort é um array JSON com exatamente dois elementos: o nome do campo e a direção.

• O campo deve ser um dos campos listados na seção Campos de ordenação do endpoint.
• A direção é ASC (crescente) ou DESC (decrescente), e não diferencia maiúsculas e minúsculas.

Os resultados podem ser ordenados por um único campo. Quando dois ou mais registros têm o mesmo valor no campo de ordenação, a API aplica um segundo campo de ordenação fixo (normalmente o nome ou o ID do registro, na mesma direção), para que a ordem seja sempre estável. Isso é importante ao paginar, pois garante que nenhum registro seja ignorado ou repetido entre as páginas.

Ordenação padrão

Quando sort é omitido, os resultados são ordenados pelo campo padrão do endpoint, em ordem crescente. O campo padrão é indicado na seção Campos de ordenação de cada endpoint de listagem. Por exemplo, as campanhas são ordenadas por name, e os detalhes das chamadas são ordenados por startedAtLocal.

Erros

Um erro 400 Bad Request é retornado quando:

• O array não contém exatamente dois elementos.
• A direção não é ASC nem DESC.
• O campo não é um campo de ordenação válido para o endpoint. A mensagem de erro inclui a lista de campos válidos.