page, sayfa boyutunu per_page ile seçersiniz. Yanıtın meta ve links alanları toplam kayıt sayısını ve diğer sayfaların adreslerini verir.
Sayfalama sayfa numarasına dayanır (offset). Cursor tabanlı sayfalama yoktur.
Parametreler
Sayfalanan her liste endpoint’i aşağıdaki iki sorgu parametresini kabul eder.
Bazı listelerin varsayılan sayfa boyutu farklıdır:
Kural dışı bir değer gönderirseniz (örneğin
per_page=500) istek 422 VALIDATION_FAILED ile reddedilir. Hata gövdesi için Hatalar sayfasına bakın.
Meta ve bağlantılar
Sayfalanan bir listenin gövdesidata, links ve meta alanlarından oluşur. Bu gövdede success alanı yoktur. Diğer yanıt biçimleri için Yanıt yapısı sayfasına bakın.
Sayfalanmayan listeler
Bazı listeler sayfalanmaz. Bu listelerpage ve per_page parametrelerini dikkate almaz ve tüm kayıtları tek yanıtta döndürür. Gövdede meta.timezone dışında sayfalama bilgisi bulunmaz. Örnekler: GET /v1/channels, GET /v1/pipelines/{id}/stages, GET /v1/oauth/scopes, GET /v1/integrations. Bir endpoint’in sayfalanıp sayfalanmadığını ilgili kaynak sayfasından kontrol edin.
Sınırlar
Bir sayfa boş döndüğünde hata oluşmaz. Döngülerde durma koşulu olarak boş
data yerine meta.last_page değerini kullanın.Tüm sayfaları gezme
Bir listenin tamamını almak içinpage değerini 1’den başlatın ve meta.last_page değerine ulaşana kadar artırın. Her istekte aynı filtreleri ve aynı sıralamayı gönderin. Filtre ve sıralama parametreleri için Filtreleme ve sıralama sayfasına bakın.
1
İlk sayfayı isteyin
page=1 ve en büyük sayfa boyutu olan per_page=100 ile başlayın.2
Meta bilgisini okuyun
Yanıttaki
meta.last_page değerini kaydedin.3
Sonraki sayfaları isteyin
page değerini birer birer artırın. Filtreleri ve sıralamayı her istekte yeniden gönderin.4
Durun
page değeri meta.last_page değerine ulaşınca döngüyü bitirin.