Paginação

Os parâmetros de página, os formatos de resposta das listas e as listas por cursor.

As listas da API são paginadas. A maioria usa número de página (page e pageSize); algumas, como o registro de envios de e-mail e as listas de comentários dos canais, usam cursor. A descrição de cada rota na Referência da API diz qual forma ela usa e o máximo de itens por página.

Por número de página

ParâmetroDescrição
pageNúmero da página, a partir de 1. O padrão é 1.
pageSizeItens por página. O padrão é 20 e o máximo, na maioria das rotas, é 100; a descrição da rota informa quando o máximo é outro.

Em geral, um valor ausente, zero, negativo ou que não é um número inteiro é tratado como o padrão, e um pageSize acima do máximo é reduzido ao máximo.

curl "https://api.vozkoia.com/leads?page=2&pageSize=50" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "X-Workspace-ID: SEU_WORKSPACE_ID"

Formatos de resposta

As listas por página respondem em um destes dois formatos. A referência mostra qual vale para cada rota.

Itens em data e a paginação em meta:

{
  "data": [],
  "meta": {
    "page": 2,
    "pageSize": 50,
    "totalPages": 4,
    "totalItems": 172
  }
}

Itens em items e a paginação no mesmo nível:

{
  "items": [],
  "page": 2,
  "page_size": 50,
  "total_items": 172,
  "total_pages": 4
}

Nos dois, a última página é a de número totalPages (ou total_pages).

Algumas listas curtas, como GET /workspaces para um usuário comum, não são paginadas e respondem com a lista inteira.

Por cursor

Nas listas por cursor, cada resposta traz um ponteiro para a próxima página. Repasse o ponteiro exatamente como recebeu, sem alterar, e mantenha os mesmos filtros em todas as páginas de uma consulta. Quando o ponteiro não vem, você chegou ao fim.

No registro de envios de e-mail (GET /email/transactional/messages), por exemplo:

ParâmetroDescrição
limitItens por página, de 1 a 100. O padrão é 50; valores acima de 100 são tratados como 100.
cursorO valor de next_cursor da página anterior. Omita na primeira página.
{
  "data": [],
  "next_cursor": "MjAyNi0xMC0zMVQxNDowNTowOVp8YzFkMmUzZjQ"
}

Essa lista não traz contagem total, e um cursor alterado é recusado com 400 e o código email_log_cursor_invalid.


Did this page help you?