Skip to main content
Todo endpoint de lista /v1 retorna o mesmo envelope e pagina da mesma forma: baseada em token e somente para frente.

O envelope de lista

string
Sempre "list".
array
A página de recursos, em uma ordem estável e determinística.
string | null
Envie este valor como page_token na próxima solicitação para obter a página seguinte. null quando não houver mais resultados.
boolean
Indica se existem mais resultados além desta página.

Parâmetros da solicitação

integer
padrão:"25"
Tamanho da página. Um número inteiro entre 1 e 500. Valores fora desse intervalo retornam um 400 com o código invalid_request.
string
O next_page_token da resposta anterior. Omita-o na primeira página.
Não há parâmetros de deslocamento (offset), nem navegação para a página anterior, nem contagens totais exatas. Para contar uma coleção, percorra-a.
Exceção: GET /v1/cohorts/{id}/members retorna no máximo 50 linhas por página, mesmo que você solicite um limit maior. has_more e next_page_token continuam refletindo o restante real da Coorte.
Autentique-se com qualquer um dos dois formatos de credencial Basic — consulte o Início rápido (apikey:secret ou secret:). Defina BASE como o host regional da organização — consulte Regiões.

Percorrendo uma lista

Carregue LIVING_SECURITY_API_KEY a partir do seu gerenciador de segredos, como no início rápido. Este exemplo requer entity:read; a chave usada no guia da primeira solicitação pode precisar dessa concessão adicional. Instale requests para Python ou jq para o exemplo em shell. Ambos os exemplos fixam uma versão, mantêm os filtros inalterados e rejeitam redirecionamentos. Eles param em caso de erro e após 1.000 páginas, em vez de informar como concluída uma varredura parcial. O tempo limite de leitura do Python limita a inatividade, não a duração total da tarefa; defina um prazo para a tarefa em sua integração. Solicite páginas até que next_page_token seja null. Prefira limit=500 para leituras em massa, de modo a cobrir a coleção com menos solicitações — consulte os limites de taxa.

Mantenha os filtros estáveis durante a paginação

Os tokens de página são cursores opacos e assinados. Cada token está vinculado à organização, à conta de serviço autenticada, à versão do contrato e ao conjunto exato de filtros da solicitação que o gerou. Alterar qualquer um desses itens no meio da varredura — por exemplo, adicionar um filtro type na segunda página — retorna um 400 com o código invalid_request no parâmetro page_token:
400 Invalid request
Para alterar os filtros, inicie uma nova varredura a partir da primeira página.
Trate page_token como uma string opaca: envie-o de volta exatamente como foi recebido. Não decodifique, não armazene a longo prazo e não construa tokens — o formato interno deles pode mudar a qualquer momento, sem aviso prévio.
Os endpoints de lista rejeitam parâmetros de consulta que não suportam com um 400 invalid_request que indica o nome do parâmetro. Consulte a referência de cada endpoint para saber quais filtros são suportados.

Lidar com uma coleção interrompida ou em alteração

Estes exemplos não tentam novamente, de forma automática, as solicitações com erro. Para 429, respeite Retry-After e siga as orientações de nova tentativa limitadas. Mantenha a mesma região, conta de serviço, versão, filtros e o último token de página processado com êxito ao tentar novamente uma leitura. Trocar as credenciais não concede acesso: cada solicitação ainda verifica as permissões atuais. Uma leitura de várias páginas não é um instantâneo da coleção. As linhas podem mudar enquanto você a percorre. Processe os recursos pelo id estável e torne as gravações posteriores idempotentes; uma reinicialização pode retornar uma linha novamente. Se um token for rejeitado, examine o erro page_token e corrija a solicitação antes de reiniciar a partir da primeira página. Não descarte silenciosamente dados já processados nem marque uma exportação interrompida como concluída. Para totais exatos de relatórios, use o recurso de relatórios apropriado em vez de tratar uma varredura de lista em tempo real como um instantâneo.