Pagination
Les endpoints de liste de l'API renvoient les données par pages. La plateforme dispose historiquement de deux schémas de pagination ; le schéma spécifique est indiqué pour chaque endpoint dans la référence interactive.
Schéma 1 — décalage et X-Total-Count
Pagination classique par décalage. La requête accepte les paramètres de requête limit (taille de page) et offset (nombre d'enregistrements à ignorer) :
curl -H "Authorization: Bearer mbp_VOTRE_JETON" "https://votre-domaine/api/bots/BOT_ID/subscribers?limit=50&offset=100"
Le nombre total d'enregistrements est renvoyé dans l'en-tête de réponse X-Total-Count. Le nombre de pages se calcule à partir de celui-ci : incrémentez offset de limit tant que offset est inférieur à la valeur de X-Total-Count. Le corps de la réponse est un tableau des éléments de la page courante.
Schéma 2 — curseur before et has_more
Pagination par curseur pour les flux ordonnés par date (par exemple, les messages d'un dialogue). La requête accepte limit et un curseur optionnel before — l'identifiant ou le marqueur du dernier élément déjà reçu :
curl -H "Authorization: Bearer mbp_VOTRE_JETON" "https://votre-domaine/api/bots/BOT_ID/users/USER_ID/dialog?limit=50&before=CURSOR"
La réponse contient une page d'éléments et un indicateur has_more. Tant que has_more est true, répétez la requête en passant dans before le curseur du dernier élément reçu. Lorsque has_more passe à false, c'est la dernière page.
Quel schéma utiliser
Vous ne choisissez pas le schéma — c'est l'endpoint qui le détermine. Les listes de référence utilisent généralement le décalage et X-Total-Count ; les flux chronologiques utilisent le curseur before et has_more. Consultez toujours la page de l'endpoint dans la référence.
Pour aller plus loin
- Démarrage rapide API — premières requêtes.
- Erreurs — codes de statut.
- Limites et tailles — restrictions des requêtes.