Paginasi
Endpoint daftar API mengembalikan data secara bertahap. Platform ini secara historis memiliki dua skema paginasi; skema spesifik ditentukan pada endpoint di referensi interaktif.
Skema 1 — offset dan X-Total-Count
Paginasi offset klasik. Permintaan menerima parameter query limit (ukuran halaman) dan offset (jumlah record yang dilewati):
curl -H "Authorization: Bearer mbp_TOKEN_ANDA" "https://domain-anda/api/bots/BOT_ID/subscribers?limit=50&offset=100"
Jumlah total record dikembalikan di header respons X-Total-Count. Berdasarkan itu, jumlah halaman dapat dihitung: terus lakukan paginasi dengan menambah offset sebesar limit, selama offset lebih kecil dari nilai X-Total-Count. Body respons adalah array elemen halaman saat ini.
Skema 2 — cursor before dan has_more
Paginasi cursor untuk feed yang diurutkan berdasarkan waktu (misalnya, pesan dialog). Permintaan menerima limit dan cursor opsional before — identifier atau penanda elemen terakhir yang sudah diterima:
curl -H "Authorization: Bearer mbp_TOKEN_ANDA" "https://domain-anda/api/bots/BOT_ID/users/USER_ID/dialog?limit=50&before=CURSOR"
Respons berisi halaman elemen dan flag has_more. Selama has_more bernilai true, ulangi permintaan dengan mengirimkan cursor elemen terakhir yang diterima di before. Ketika has_more menjadi false — itulah halaman terakhir.
Skema mana yang dipilih
Anda tidak memilih skema — skema ditentukan oleh endpoint. Daftar referensi biasanya menggunakan offset dan X-Total-Count; feed berdasarkan waktu menggunakan cursor before dan has_more. Selalu periksa halaman endpoint di referensi.
Selanjutnya
- Mulai cepat API — permintaan pertama.
- Error — kode status.
- Batas dan ukuran — batasan permintaan.