Ordinamento

Tutti gli endpoint di elenco accettano un parametro di query sort opzionale, che definisce l'ordine dei record restituiti.

Sintassi

Il parametro sort è un array JSON con esattamente due elementi: il nome del campo e la direzione.

• Il campo deve essere uno dei campi elencati nella sezione Campi di ordinamento dell'endpoint.
• La direzione è ASC (crescente) oppure DESC (decrescente), senza distinzione tra maiuscole e minuscole.

I risultati possono essere ordinati in base a un solo campo. Quando due o più record hanno lo stesso valore per il campo di ordinamento, l'API applica un secondo campo di ordinamento fisso (di solito il nome o l'ID del record, nella stessa direzione), così l'ordine è sempre stabile. Questo è importante durante la paginazione, poiché garantisce che nessun record venga saltato o ripetuto tra una pagina e l'altra.

Ordinamento predefinito

Quando sort viene omesso, i risultati sono ordinati in base al campo predefinito dell'endpoint, in ordine crescente. Il campo predefinito è indicato nella sezione Campi di ordinamento di ogni endpoint di elenco. Ad esempio, le campagne sono ordinate per name, e i dettagli delle chiamate sono ordinati per startedAtLocal.

Errori

Viene restituito un errore 400 Bad Request quando:

• L'array non contiene esattamente due elementi.
• La direzione non è ASC o DESC.
• Il campo non è un campo di ordinamento valido per l'endpoint. Il messaggio di errore include l'elenco dei campi validi.