RoomScope

Última atualização

Paginação

Listas que podem crescer sem limite são paginadas com um cursor opaco. Peça um tamanho de página com limit e depois envie o nextCursor de cada página para obter a seguinte.

Cursores

Uma resposta paginada traz nextCursor. Envie-o de volta no parâmetro de query cursor para obter a próxima página; quando ele for null, não há nada mais antigo. As páginas vêm da mais recente para a mais antiga. Trate o cursor como opaco: o formato dele pode mudar.

GET /v1/live/sessions?limit=100
{  "data": {    "items": [ … ],    "nextCursor": "2026-10-31T07:51:44.935Z",    "historyWindowDays": 365,    "historyTruncated": false  }}

Cada lista define sua própria faixa e seu valor padrão de limit; a referência os mostra ao lado do parâmetro. Cada página é cobrada como uma chamada.

Janela de histórico

O histórico registrado é limitado pelo plano. historyWindowDays indica até quanto tempo atrás o espaço de trabalho pode ler, e historyTruncated: true significa que existem dados mais antigos, mas fora dessa janela.

Listas curtas não são paginadas
Rankings, regiões, regras de alerta e exportações vêm completos; aceitam um limit quando faz sentido, mas nenhum cursor.

Ler todas as páginas

let cursor = null;const sessions = [];do {  const params = new URLSearchParams({ limit: "100", ...(cursor ? { cursor } : {}) });  const res = await fetch(`https://api.toktokdata.live/v1/live/sessions?${params}`, {    headers: { Authorization: `Bearer ${process.env.ROOMSCOPE_API_KEY}` },  });  const { data } = await res.json();  sessions.push(...data.items);  cursor = data.nextCursor;} while (cursor);
Esta página foi útil?