Management API

Paginierung

Paginierung von Ergebnissen in der Management API

Als Markdown anzeigen

Alle GET-Endpunkte der Management API unterstützen Paginierung, um große Datenmengen effizient zu verwalten. Der Paginierungsmechanismus verwendet zwei Parameter: page und limit.

Query-Parameter

  • page: Die Seitennummer, die abgerufen werden soll. Dieser Parameter gibt an, welche Seite der Daten Sie abrufen möchten. Der Standardwert ist 1.

  • limit: Die Anzahl der Einträge pro Seite. Der Standardwert ist 10, der Maximalwert beträgt 100.

Beispielanfrage

curl -X GET "https://api.otark.com/v1/assets?limit=20&page=2" \
-H "X-Api-Key: IHR_API_KEY"

Woran der Aufrufer die letzte Seite erkennt

Jede Antwort trägt neben der Liste ein Paginierungsobjekt. Der Aufrufer muss die letzte Seite damit nicht erraten und keinen Zusatzaufruf machen, um sie zu erkennen:

FeldBedeutung
pagelaufende Seitennummer, beginnend bei 1
limitHöchstzahl der Einträge pro Seite
total_itemsGesamtzahl der Einträge über alle Seiten
total_pagesGesamtzahl der Seiten

Die letzte Seite ist erreicht, wenn page gleich total_pages ist. Alle vier Felder sind Pflichtfelder.

{
  "assets": [ … ],
  "pagination": { "page": 2, "limit": 20, "total_items": 23, "total_pages": 2 }
}

Die Management API paginiert als einzige nach Seitennummern. Alle übrigen APIs paginieren cursorbasiert: Sie nehmen limit und einen Cursor after entgegen und führen in der Antwort pagination mit has_more und next_cursor statt Seitennummern.

Zuletzt aktualisiert am