Skip to main content
Cada endpoint de llista de /v1 retorna el mateix envolupant i pagina de la mateixa manera: basada en tokens i només cap endavant.

L’envolupant de llista

string
Sempre "list".
array
La pàgina de recursos, en un ordre estable i determinista.
string | null
Passeu-lo com a page_token a la sol·licitud següent per obtenir la pàgina següent. null quan no hi ha més resultats.
boolean
Indica si hi ha més resultats més enllà d’aquesta pàgina.

Paràmetres de la sol·licitud

integer
predeterminat:"25"
Mida de la pàgina. Un enter entre 1 i 500. Els valors fora d’aquest interval retornen un 400 amb el codi invalid_request.
string
El next_page_token de la resposta anterior. Ometeu-lo per a la primera pàgina.
No hi ha paràmetres de desplaçament (offset), ni recorregut cap a la pàgina anterior, ni recomptes totals exactes. Per comptar una col·lecció, cal recórrer-la.
Excepció: GET /v1/cohorts/{id}/members retorna com a màxim 50 files per pàgina, fins i tot quan sol·liciteu un limit superior. has_more i next_page_token continuen reflectint el romanent real del Cohort.
Autentiqueu-vos amb qualsevol de les dues formes de credencial Basic; vegeu Quickstart (apikey:secret o secret:). Establiu BASE amb el host regional de l’organització; vegeu Regions.

Recórrer una llista

Carregueu LIVING_SECURITY_API_KEY des del vostre gestor de secrets, com a la guia d’inici ràpid. Aquest exemple requereix entity:read; és possible que la clau utilitzada a la guia de la primera sol·licitud necessiti aquest permís addicional. Instal·leu requests per a Python o jq per a l’exemple d’intèrpret d’ordres. Tots dos exemples fixen una versió, mantenen els filtres sense canvis i rebutgen les redireccions. S’aturen davant d’errors i després de 1.000 pàgines, en lloc d’informar d’un recorregut parcial com si fos complet. El temps d’espera de lectura de Python limita la inactivitat, no la durada total de la tasca; imposeu un termini per a la tasca a la vostra integració. Sol·liciteu pàgines fins que next_page_token sigui null. Preferiu limit=500 per a lectures massives, de manera que cobriu la col·lecció amb menys sol·licituds; vegeu els límits de velocitat.

Mantingueu els filtres estables durant la paginació

Els tokens de pàgina són cursors opacs i signats. Cada token està vinculat a l’organització, al compte de servei autenticat, a la versió del contracte i al conjunt exacte de filtres de la sol·licitud que l’ha generat. Canviar qualsevol d’aquests elements a mig recorregut (per exemple, afegir un filtre type a la segona pàgina) retorna un 400 amb el codi invalid_request al paràmetre page_token:
400 Invalid request
Per canviar els filtres, inicieu un recorregut nou des de la primera pàgina.
Tracteu page_token com una cadena opaca: torneu-lo a passar exactament tal com l’heu rebut. No descodifiqueu, emmagatzemeu a llarg termini ni construïu tokens: el seu format intern pot canviar en qualsevol moment sense previ avís.
Els endpoints de llista rebutgen els paràmetres de consulta que no admeten amb un 400 invalid_request que indica el nom del paràmetre. Consulteu la referència de cada endpoint per conèixer els filtres admesos.

Gestioneu una col·lecció interrompuda o canviant

Aquests exemples no reintenten els errors automàticament. Per a 429, respecteu Retry-After i seguiu les indicacions de reintent acotades. Mantingueu la mateixa regió, compte de servei, versió, filtres i l’últim token de pàgina processat correctament en reintentar una lectura. Canviar les credencials no concedeix accés: cada sol·licitud continua comprovant els permisos actuals. Una lectura de diverses pàgines no és una instantània de la col·lecció. Les files poden canviar mentre la recorreu. Processeu els recursos pel seu id estable i feu que les escriptures posteriors siguin idempotents; un reinici pot tornar a retornar una fila. Si es rebutja un token, examineu l’error page_token i corregiu la sol·licitud abans de reiniciar des de la primera pàgina. No descarteu silenciosament les dades ja processades ni marqueu una exportació interrompuda com a completa. Per obtenir totals exactes d’informes, utilitzeu el recurs d’informes adequat en lloc de tractar un recorregut de llista en viu com una instantània.