Skip to main content
Setiap endpoint daftar /v1 mengembalikan envelope yang sama dan melakukan paginasi dengan cara yang sama: berbasis token dan hanya ke arah maju.

Envelope daftar

string
Selalu "list".
array
Halaman berisi resource, dalam urutan yang stabil dan deterministik.
string | null
Teruskan nilai ini sebagai page_token pada permintaan berikutnya untuk mengambil halaman selanjutnya. null jika tidak ada hasil lagi.
boolean
Menunjukkan apakah masih ada hasil di luar halaman ini.

Parameter permintaan

integer
default:"25"
Ukuran halaman. Bilangan bulat antara 1 dan 500. Nilai di luar rentang tersebut mengembalikan 400 dengan kode invalid_request.
string
next_page_token dari respons sebelumnya. Lewati parameter ini untuk halaman pertama.
Tidak ada parameter offset, tidak ada penelusuran ke halaman sebelumnya, dan tidak ada jumlah total yang tepat. Untuk menghitung sebuah koleksi, telusuri koleksi tersebut.
Pengecualian: GET /v1/cohorts/{id}/members mengembalikan paling banyak 50 baris per halaman, meskipun Anda meminta limit yang lebih tinggi. has_more dan next_page_token tetap mencerminkan sisa Kelompok yang sebenarnya.
Lakukan autentikasi dengan salah satu bentuk kredensial Basic — lihat Quickstart (apikey:secret atau secret:). Atur BASE ke host regional organisasi — lihat Regions.

Menelusuri daftar

Muat LIVING_SECURITY_API_KEY dari secret manager Anda seperti pada quickstart. Contoh ini memerlukan entity:read; kunci yang digunakan untuk panduan permintaan pertama mungkin memerlukan izin tambahan tersebut. Instal requests untuk Python atau jq untuk contoh shell. Kedua contoh mengunci versi, menjaga filter tetap tidak berubah, dan menolak pengalihan. Keduanya berhenti saat terjadi error dan setelah 1.000 halaman, alih-alih melaporkan penelusuran yang parsial sebagai lengkap. Read timeout pada Python membatasi waktu tidak aktif, bukan total durasi tugas; terapkan batas waktu tugas pada integrasi Anda. Minta halaman hingga next_page_token bernilai null. Utamakan limit=500 untuk pembacaan massal agar koleksi tercakup dalam lebih sedikit permintaan — lihat rate limits.

Jaga filter tetap stabil selama paginasi

Token halaman adalah kursor opak yang ditandatangani. Setiap token terikat pada organisasi, service account yang diautentikasi, versi kontrak, dan kumpulan filter yang persis sama dari permintaan yang menghasilkannya. Mengubah salah satunya di tengah penelusuran — misalnya, menambahkan filter type pada halaman kedua — akan mengembalikan 400 dengan kode invalid_request pada parameter page_token:
400 Invalid request
Untuk mengubah filter, mulai penelusuran baru dari halaman pertama.
Perlakukan page_token sebagai string opak: teruskan kembali persis seperti yang diterima. Jangan mendekode, menyimpan jangka panjang, atau membuat token sendiri — format internalnya dapat berubah kapan saja tanpa pemberitahuan.
Endpoint daftar menolak parameter kueri yang tidak didukungnya dengan 400 invalid_request yang menyebutkan nama parameter tersebut. Periksa referensi setiap endpoint untuk mengetahui filter yang didukung.

Menangani koleksi yang terputus atau berubah

Contoh-contoh ini tidak mencoba ulang error secara otomatis. Untuk 429, patuhi Retry-After dan ikuti panduan percobaan ulang yang terbatas. Pertahankan region, service account, versi, filter, dan token halaman terakhir yang berhasil diproses yang sama saat mencoba ulang pembacaan. Mengganti kredensial tidak memberikan akses: setiap permintaan tetap memeriksa izin saat ini. Pembacaan multi-halaman bukanlah snapshot dari koleksi. Baris dapat berubah selama Anda menelusurinya. Proses resource berdasarkan id yang stabil dan buat penulisan downstream bersifat idempoten; proses mulai ulang dapat mengembalikan suatu baris lagi. Jika token ditolak, periksa error page_token dan perbaiki permintaan sebelum memulai ulang dari halaman pertama. Jangan membuang data yang telah diproses tanpa pemberitahuan atau menandai ekspor yang terputus sebagai selesai. Untuk total pelaporan yang tepat, gunakan resource pelaporan yang sesuai, alih-alih memperlakukan penelusuran daftar langsung sebagai snapshot.