Listar eventos

Parâmetros

Lingara-Versionheaderstringopcional

A versão da API com que responder a este pedido. Sem ela, um token de acesso recebe a versão a que o seu cliente está associado, e um pedido sem token recebe a versão atual. A versão ainda em desenvolvimento só é alcançada indicando-a aqui. Uma versão desconhecida responde 400 com o código api_version_unknown. GET /v1/versions lista as versões.

cursorquerystringopcional

De onde continuar: o next_cursor de uma página anterior, ou o id: de um evento do fluxo. Um cursor com mais de 30 dias recebe 410 com o código cursor_expired.

startquerystringopcional

Onde começar sem cursor: latest para os eventos a partir de agora, ou oldest para todos os eventos ainda guardados.

typesqueryarray of stringopcional

Apenas estes tipos de evento, separados por vírgulas. Sem ele, todos os tipos que os âmbitos do seu token podem ler.

limitqueryintegeropcional

O número máximo de eventos que uma página devolve, de 1 a 100.

Respostas

200 Uma página de eventos e o cursor a partir do qual continuar

itemsarray of EventEnvelopeobrigatório

idstringobrigatório

typestringobrigatório

created_atstringobrigatório

api_versionstringobrigatório

subjectstringobrigatório

dataobjectobrigatório

next_cursorstringobrigatório

has_morebooleanobrigatório

Erros

410application/json

api_version_discontinued: a versão da API deste pedido foi descontinuada. cursor_expired: o cursor tem mais de 30 dias; recomece sem ele.

4XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

503application/json · text/plain

O serviço está temporariamente indisponível; tente novamente após o número de segundos indicado em Retry-After. Durante a manutenção, o corpo é texto simples em vez do envelope de erro.

5XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

codestringobrigatório

O motivo pelo qual o pedido foi recusado, como um código estável para ramificar a lógica: por exemplo insufficient_scope (403), rate_limited (429) e, para um cliente com faturação por utilização, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobrigatório

Exemplo

curl "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Prefere uma biblioteca? Veja a secção Bibliotecas.