Skip to main content

Pagination des Résultats avec l'Offset

L'API prend en charge la pagination des résultats pour vous permettre de gérer efficacement de grandes quantités de données. La pagination des résultats vous permet de diviser les informations en plusieurs pages plus petites, ce qui est particulièrement utile lorsque vous récupérez une liste de résultats qui pourrait être très longue.

L'un des paramètres clés pour effectuer la pagination est l'offset. L'offset détermine à partir de quel élément de la liste des résultats, vous souhaitez commencer à afficher les données. Voici comment il fonctionne :

  • Offset à 0 : Si vous définissez l'offset à 0, vous commencerez à afficher les résultats depuis la première page de la liste. Par exemple, avec une limite de 10 résultats par page, l'offset 0 affichera les résultats 1 à 10.

  • Offset à une valeur supérieure à 0 : Si vous définissez l'offset à une valeur supérieure à 0, vous sauterez les pages initiales de résultats et commencerez à afficher les données à partir de la "page" correspondant à cette valeur d'offset. Par exemple, avec une limite de 10 résultats par page, l'offset 1 affichera les résultats 11 à 20.

Lorsque l'offset est disponible dans une requête, voici les éléments à ajouter au Request Body :

{
    // Initial request body
    "limit": X,
    "offset": Y
}

Où X et Y représentent un nombre entier

Par défaut, la limite (ou "limit") est à 10, et l'offset est à 0

Par exemple, supposons que vous ayez une liste de 33 résultats et que vous définissiez une limite de 10 résultats par requêtes. Voici comment l'offset fonctionnerait dans ce cas :

  • Offset 0 affiche : 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, correspondant à la première page.
  • Offset 1 affiche : 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, correspondant à la deuxième page.
  • Offset 2 affiche : 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, correspondant à la troisième page.
  • Offset 3 affiche : 31, 32, 33, correspondant à la quatrième page.

L'utilisation judicieuse de l'offset permet aux développeurs de créer une expérience utilisateur fluide en divisant les données en pages plus petites, ce qui rend la navigation plus efficace et moins chargée en termes de données à récupérer à la fois.


Back to top