Tri

Tous les points de terminaison de listage acceptent un paramètre de requête facultatif sort, qui définit l’ordre des enregistrements renvoyés.

Syntaxe

Le paramètre sort est un tableau JSON contenant exactement deux éléments : le nom du champ et le sens du tri.

• Le champ doit être l’un des champs listés dans la section Champs de tri du point de terminaison.
• Le sens est soit ASC (croissant), soit DESC (décroissant), et n’est pas sensible à la casse.

Les résultats ne peuvent être triés que selon un seul champ. Lorsque deux enregistrements ou plus ont la même valeur pour le champ de tri, l’API applique un second champ de tri fixe (généralement le nom ou l’ID de l’enregistrement, dans le même sens), afin que l’ordre soit toujours stable. C’est important lors de la pagination, car cela garantit qu’aucun enregistrement n’est omis ni répété d’une page à l’autre.

Ordre de tri par défaut

Lorsque sort est omis, les résultats sont triés selon le champ par défaut du point de terminaison, en ordre croissant. Le champ par défaut est indiqué dans la section Champs de tri de chaque point de terminaison de listage. Par exemple, les campagnes sont triées par name, et les détails des appels par startedAtLocal.

Erreurs

Une erreur 400 Bad Request est renvoyée lorsque :

• Le tableau ne contient pas exactement deux éléments.
• Le sens n’est ni ASC ni DESC.
• Le champ n’est pas un champ de tri valide pour le point de terminaison. Le message d’erreur inclut la liste des champs valides.