Pagination

Dans ce guide, nous allons voir comment gérer des réponses paginées lors d'une requête GET à l'API.
Par défaut, toutes les réponses sont composées d'une liste de maximum 100 éléments. Si vous le souhaitez, vous pouvez ajuster cette valeur jusqu'à 1000 en ajoutant un paramètre limit à votre requête.

Quand l'API retourne une liste, la pagination est incluse, peu importe la taille de la liste. Dans une réponse paginée, les objets sont inclus sous le champ data et un champ metadata est présent à la racine. Dans cet objet, nous pouvons voir la taille totale de la portion de donnée à laquelle on souhaite accéder via totalCount et notre position dans la liste via skip.
Lorsque vous passez le paramètre skip dans une requête, la réponse retournée débutera après le nombre d'élément indiqué.

Example de pagination

curl -G "https://api.shunter.fr/v1/organizers/:_id/events?limit=10&skip=10" \
  -H "Authorization: X-API-KEY {YOUR_API_KEY}" \

{
  "metadata": {
    "totalCount": 13,
    "skip": 10,
    "limit": 10,
    "sort": "_id:asc",
    "filters": {},
    "search": ""
  },
  "data": [
    {
      "_id": "6284fc540000011dfcca3b15",
      // ...
    },
    {
      "id": "6283868c0000011dfcca3174"
      // ...
    },
    {
      "id": "627928940000011dfcca4ee3"
      // ...
    }
  ]
}

Opérateurs de filtrage disponibles

Vous pouvez utiliser une multitude d'opérateurs pour filtrer les documents selon leurs champs. Voici une liste des opérateurs disponibles L'utilisation des opérateurs se fait en ajoutant opérateur: avant la valeur recherchée. Par exemple, pour filtrer les évènements dont le champ collectedAmounts.funds est supérieur à 10000, vous pouvez utiliser collectedAmounts.funds=gt:10000.