Fonctionnement de la pagination
- Effectuez votre requête initiale avec
max_results - Vérifiez la présence d’un
next_tokendans l’objetmetade la réponse - S’il est présent, effectuez une autre requête en utilisant ce jeton comme valeur de
pagination_token - Répétez jusqu’à ce qu’aucun
next_tokenne soit renvoyé
Jetons de pagination
| Jeton | Description |
|---|---|
next_token | Dans le champ meta de la réponse. Utilisez-le pour obtenir la page suivante. |
previous_token | Dans le champ meta de la réponse. Utilisez-le pour revenir à la page précédente. |
pagination_token | Paramètre de la requête. Définissez-le sur la valeur de next_token ou previous_token. |
Structure de la réponse
next_token est omis :
Paramètres de pagination
| Paramètre | Description | Valeur par défaut |
|---|---|---|
max_results | Résultats par page | Spécifique à l’endpoint |
pagination_token | Jeton issu de la réponse précédente | Aucune |
max_results.
Exemple : parcourir tous les résultats avec la pagination
- Python
- JavaScript
Bonnes pratiques
Utilisez max_results
Demandez la valeur maximale possible pour
max_results afin de réduire le nombre d’appels à l’API.Gérez les pages partielles
La dernière page peut contenir moins de résultats que
max_results.Stockez les jetons
Enregistrez
next_token si vous devez reprendre la pagination plus tard.N'effectuez pas de polling avec la pagination
Pour obtenir de nouvelles données, utilisez
since_id plutôt que de paginer en boucle.Ordre des résultats
- Premier résultat de la première page = le plus récent
- Dernier résultat de la dernière page = le plus ancien
Remarques
- Les jetons de pagination sont des chaînes opaques : ne cherchez pas à les analyser ni à les modifier
- Les jetons peuvent expirer après un certain temps
- Si vous obtenez moins de résultats que
max_results, il peut encore rester des résultats (poursuivez jusqu’à ce qu’il n’y ait plus denext_token) - Utilisez les SDK pour gérer automatiquement la pagination
Prochaines étapes
Limites de taux
Comprendre les limites de taux applicables à la pagination.
SDKs
Bibliothèques avec pagination intégrée.