Paramètres

Les paramètres de requête limitent les données renvoyées par un point de terminaison. Toutes les valeurs des paramètres de requête doivent être encodées pour une URL.

Les paramètres suivants attendent des valeurs selon une syntaxe particulière. Pour consulter la liste complète des paramètres requis et optionnels de chaque point de terminaison, reportez-vous à la référence de l’API.

sélectionner

Exemple : field_a,field_b,field_c

Une liste obligatoire de noms de champs, séparés par des virgules. Cela indique quels champs renvoyer depuis le point de terminaison. Tous les points de terminaison n’acceptent pas ce paramètre.

Consultez le schéma de réponse du point de terminaison dans la référence de l'API pour obtenir la liste des noms de champs valides.

where

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

Une expression de filtre pour affiner les résultats. La syntaxe est décrite en détail dans Syntaxe de filtrage. Tous les points de terminaison n’acceptent pas ce paramètre.

Consultez la description des paramètres du point de terminaison dans la référence de l’API pour obtenir la liste des noms de champs valides pouvant être utilisés dans l’expression de filtre. Cela peut différer de la liste des noms de champs du paramètre select.

order_by

Exemple : field_a:desc,field_b:asc

Trie les résultats selon le(s) champ(s) spécifié(s) et la direction (desc ou asc). Tous les points de terminaison n’acceptent pas ce paramètre.

Consultez le schéma de réponse du point de terminaison dans la référence de l'API pour obtenir la liste des noms de champs valides. C’est identique à la liste des noms de champs du paramètre select.