Acceso anticipadoSolo por invitación, y los SDK aún no están publicados.Pedir una invitación
Ir al contenido
Docs

API de lectura

Consulta los eventos de un proyecto desde un script con una clave de lectura.

El panel es una forma de leer eventos. La API de lectura es la otra: los mismos filtros, en JSON, para un script, un notebook, una tarea programada o un agente.

Autenticación

En la página API keys del proyecto, elige New key y pon What it can do en Read events. La clave empieza por lyr_read_ y se muestra una sola vez. Envíala como bearer token a https://app.lyrelog.com. Los ejemplos de abajo la guardan en una variable de shell:

export LYRELOG_READ_KEY=lyr_read_...
curl -s https://app.lyrelog.com/v1/events \
  -H "Authorization: Bearer $LYRELOG_READ_KEY"

Una clave de lectura ve todos los eventos de su proyecto y nada más. Guárdala en un servidor: quien la tenga puede leer los eventos de las personas que usan tu app. Una clave Full access también lee; una clave de ingesta no puede (403).

Listar eventos

GET /v1/events devuelve primero los eventos más recientes, de 100 en 100, de las últimas 24 horas salvo que indiques otra cosa.

ParámetroSignificado
from, toMilisegundos Unix. Por defecto, las últimas 24 horas.
levelUno o más niveles, separados por comas: error,critical
category, messageEl área y el nombre del evento. Varios valores con |, ! delante para excluir: message=!http_request_served
user, session, installUn id
env, platformproduction, ios... Sin ellos, todos los entornos y plataformas.
version, os, device, localeLa versión de la app, la versión del sistema operativo (27.2.0), el modelo de dispositivo y la configuración regional
countryDónde está la persona: el país de la dirección desde la que llegaron los eventos o, si no, la región de la configuración regional del dispositivo (es_ES es ES)
verifiedCómo está verificado un evento: server (enviado con una clave de servidor), app_attest (enviado por tu app de Apple, demostrado con App Attest), key_attestation (enviado por tu app de Android, demostrado con Key Attestation), none (sin verificar)
attrpath:value sobre un atributo, o path!:value para excluir. Repítelo para poner varios.
qTexto en el mensaje o en el área (sin distinguir mayúsculas), o un id exacto de evento, usuario, sesión o instalación. Los atributos no se buscan: usa attr.
limitDe 1 a 1000, 100 por defecto
orderasc para los más antiguos primero
cursorEl next_cursor de la respuesta anterior, para la página siguiente

category, message, user, session, install, env, platform, version, os, device, locale, country y verified aceptan varios valores separados por | ("es cualquiera de"), o una lista con ! delante ("no es"): os=26.4|27.2.0, platform=!web. Un valor de attr también acepta |, y se excluye con ! después de la ruta: attr=plan!:free|trial. Los modelos de dispositivo contienen comas (iPhone18,1), por eso el separador es |.

# Errors on iOS in production in the last hour
curl -s -G https://app.lyrelog.com/v1/events \
  -H "Authorization: Bearer $LYRELOG_READ_KEY" \
  --data-urlencode "level=error,critical" \
  --data-urlencode "platform=ios" \
  --data-urlencode "env=production" \
  --data-urlencode "from=$(( ($(date +%s) - 3600) * 1000 ))"

La respuesta es {"events": [...], "next_cursor": "..."}; next_cursor es null en la última página. Cada evento tiene event_id, ts (milisegundos Unix), level, category, message, user_id, install_id, session_id y attrs, más los campos del resource (app_id, app_version, app_build, os_name, os_version, device_model, locale, environment, platform), country y verified_by: "server" cuando el evento llegó con una clave de servidor, "app_attest" cuando tu app de Apple lo demostró con App Attest, "key_attestation" cuando tu app de Android lo demostró con Key Attestation, "" cuando no está verificado (consulta Eventos verificados). La lista deja fuera el payload: pide un evento concreto para obtenerlo.

Todas las páginas

Un cursor solo continúa la consulta de la que salió: envía los mismos filtros con él. Sin from y to, la ventana se mueve con el reloj, así que fíjalos cuando leas varias páginas. Esto lee todos los errores de los últimos 7 días, los más antiguos primero, de 1000 en 1000 (necesita jq):

FROM=$(( ($(date +%s) - 7*86400) * 1000 )); TO=$(( $(date +%s) * 1000 )); CURSOR=""
while :; do
  PAGE=$(curl -s -G https://app.lyrelog.com/v1/events \
    -H "Authorization: Bearer $LYRELOG_READ_KEY" \
    --data-urlencode "level=error,critical" --data-urlencode "order=asc" --data-urlencode "limit=1000" \
    --data-urlencode "from=$FROM" --data-urlencode "to=$TO" ${CURSOR:+--data-urlencode "cursor=$CURSOR"})
  echo "$PAGE" | jq -c '.events[]'
  CURSOR=$(echo "$PAGE" | jq -r '.next_cursor // empty'); [ -z "$CURSOR" ] && break
done

Un evento

GET /v1/events/{event_id}?ts={ts} devuelve un evento, con todo su payload, como {"event": {...}}. Pasa el ts (milisegundos Unix) que te dio la lista: los eventos se guardan por tiempo, así que con el id solo habría que buscar entre todos ellos.

curl -s -G "https://app.lyrelog.com/v1/events/6f1b2c3d-5a1e-4c1f-9e7a-0a1b2c3d4e5f" \
  -H "Authorization: Bearer $LYRELOG_READ_KEY" \
  --data-urlencode "ts=1794996000123"
{"event":{"event_id":"6f1b2c3d-5a1e-4c1f-9e7a-0a1b2c3d4e5f","ts":1794996000123,"level":"error","category":"checkout","message":"payment_declined","user_id":"user-1","install_id":"","session_id":"2f9a...","app_id":"com.example.app","app_version":"2.0","app_build":"202611181200","os_name":"iOS","os_version":"27.2.0","device_model":"iPhone18,1","locale":"es_ES","country":"ES","environment":"production","platform":"ios","verified_by":"","attrs":{"code":51},"payload":{"response":"..."}}}

Un campo que la app no envió es un string vacío. payload se omite cuando el evento no tiene.

Límites y errores

CódigoSignificado
400Un parámetro es incorrecto; el cuerpo dice cuál. Por ejemplo: from no anterior a to, un rango de más de 400 días, más de 8 filtros attr, más de 100 valores en un filtro, un nivel desconocido, limit fuera de 1 a 1000, un cursor no válido
401Sin clave, o con una desconocida o revocada
403La clave no puede leer (una clave de ingesta)
404No hay ningún evento con ese id y ese ts
429Más de 120 peticiones por minuto con esta clave (Retry-After: 60); el proyecto ya está ejecutando 4 consultas a la vez, contando juntos el panel y sus claves (Retry-After: 2); o más de 60 claves desconocidas desde tu dirección en 15 minutos
500{"error":"something went wrong on the server"}. Una consulta que tarda más de 15 segundos acaba así: acota el rango o añade filtros

Un error devuelve {"error": "..."}. Tras un 429, espera lo que indique Retry-After antes de volver a intentarlo.

Las respuestas nunca se cachean (Cache-Control: no-store). La API no tiene headers CORS a propósito: una clave de lectura no debe estar en un navegador.