Skip to main content
Každý koncový bod seznamu /v1 vrací stejnou obálku a stránkuje stejným způsobem: pomocí tokenů, pouze směrem vpřed.

Obálka seznamu

string
Vždy "list".
array
Stránka zdrojů ve stabilním, deterministickém pořadí.
string | null
Předejte tuto hodnotu jako page_token v dalším požadavku, abyste získali následující stránku. null, pokud již nejsou k dispozici další výsledky.
boolean
Udává, zda existují další výsledky za touto stránkou.

Parametry požadavku

integer
výchozí:"25"
Velikost stránky. Celé číslo od 1 do 500. Hodnoty mimo tento rozsah vrátí 400 s kódem invalid_request.
string
Hodnota next_page_token z předchozí odpovědi. U první stránky ji vynechejte.
Neexistují žádné parametry offsetu, žádné procházení zpět na předchozí stránku ani přesné celkové počty. Chcete-li spočítat položky kolekce, projděte ji celou.
Výjimka: GET /v1/cohorts/{id}/members vrací nejvýše 50 řádků na stránku, i když požadujete vyšší limit. has_more a next_page_token nadále odpovídají skutečnému zbytku kohorty.
Ověřujte se pomocí kteréhokoli z obou typů přihlašovacích údajů Basic – viz Rychlý start (apikey:secret nebo secret:). Nastavte BASE na regionální hostitele organizace – viz Regiony.

Procházení seznamu

Načtěte LIVING_SECURITY_API_KEY ze svého správce tajných klíčů stejně jako v rychlém startu. Tento příklad vyžaduje entity:read; klíč použitý v návodu k prvnímu požadavku může potřebovat toto dodatečné oprávnění. Nainstalujte requests pro Python nebo jq pro příklad v shellu. Oba příklady používají pevně danou verzi, ponechávají filtry beze změny a odmítají přesměrování. Při chybách a po 1 000 stránkách se zastaví, místo aby neúplné procházení ohlásily jako dokončené. Časový limit čtení v Pythonu omezuje nečinnost, nikoli celkovou dobu úlohy; časový limit celé úlohy nastavte ve své integraci. Načítejte stránky, dokud next_page_token nemá hodnotu null. Pro hromadné čtení dávejte přednost limit=500, abyste kolekci pokryli menším počtem požadavků – viz limity četnosti požadavků.

Udržujte filtry během stránkování beze změny

Tokeny stránek jsou neprůhledné podepsané kurzory. Každý token je vázán na organizaci, ověřený servisní účet, verzi kontraktu a přesnou sadu filtrů požadavku, který jej vytvořil. Změna kteréhokoli z těchto prvků uprostřed procházení – například přidání filtru type na druhé stránce – vrátí 400 s kódem invalid_request u parametru page_token:
400 Invalid request
Chcete-li filtry změnit, zahajte nové procházení od první stránky.
Považujte page_token za neprůhledný řetězec: předejte jej zpět přesně v podobě, v jaké jste jej obdrželi. Tokeny nedekódujte, neukládejte dlouhodobě ani nevytvářejte – jejich vnitřní formát se může kdykoli bez upozornění změnit.
Koncové body seznamů odmítnou parametry dotazu, které nepodporují, odpovědí 400 invalid_request s uvedením názvu parametru. Podporované filtry naleznete v referenci jednotlivých koncových bodů.

Postup při přerušené nebo se měnící kolekci

Tyto příklady chyby automaticky neopakují. U 429 respektujte Retry-After a řiďte se omezenými pokyny k opakování požadavků. Při opakování čtení ponechte stejný region, servisní účet, verzi, filtry a poslední úspěšně zpracovaný token stránky. Změna přihlašovacích údajů přístup neposkytuje: každý požadavek si znovu ověřuje aktuální oprávnění. Čtení více stránek není snímkem kolekce. Řádky se mohou během procházení měnit. Zdroje zpracovávejte podle jejich stabilního id a zajistěte, aby následné zápisy byly idempotentní; po restartu se může řádek vrátit znovu. Pokud je token odmítnut, zkontrolujte chybu page_token a opravte požadavek, než začnete znovu od první stránky. Dříve zpracovaná data mlčky nezahazujte ani nepovažujte přerušený export za dokončený. Pro přesné součty v reportech použijte příslušný zdroj reportingu, místo abyste procházení živého seznamu považovali za snímek.