API de lecture
Interrogez les événements d'un projet depuis un script avec une clé de lecture.
Le tableau de bord est une façon de lire les événements. L'API de lecture (read API) est l'autre : les mêmes filtres, en JSON, pour un script, un notebook, une tâche planifiée ou un agent.
Authentification
Sur la page API keys du projet, choisissez New key et réglez What it can do sur
Read events. La clé commence par lyr_read_ et ne s'affiche qu'une fois. Envoyez-la comme
bearer token à https://app.lyrelog.com. Les exemples ci-dessous la gardent dans une variable
shell :
export LYRELOG_READ_KEY=lyr_read_...
curl -s https://app.lyrelog.com/v1/events \
-H "Authorization: Bearer $LYRELOG_READ_KEY"Une clé de lecture voit tous les événements de son projet, et rien d'autre. Gardez-la sur un
serveur : quiconque la détient peut lire les événements de vos utilisateurs. Une clé
Full access permet aussi de lire ; une clé d'ingestion, non (403).
Lister les événements
GET /v1/events renvoie les événements les plus récents d'abord, 100 à la fois, sur les
24 dernières heures sauf indication contraire.
| Paramètre | Signification |
|---|---|
from, to | Millisecondes Unix. Par défaut : les 24 dernières heures. |
level | Un ou plusieurs niveaux, séparés par des virgules : error,critical |
category, message | Le domaine et le nom de l'événement. Plusieurs valeurs avec |, ! devant pour exclure : message=!http_request_served |
user, session, install | Un identifiant |
env, platform | production, ios... Sans eux, tous les environnements et toutes les plateformes. |
version, os, device, locale | La version de l'app, la version de l'OS (27.2.0), le modèle d'appareil et les paramètres régionaux |
country | Où se trouve la personne : le pays de l'adresse d'où viennent les événements, sinon la région des paramètres régionaux de l'appareil (es_ES donne ES) |
verified | Comment un événement est vérifié : server (envoyé avec une clé serveur), app_attest (envoyé par votre app Apple, prouvée avec App Attest), key_attestation (envoyé par votre app Android, prouvée avec Key Attestation), none (non vérifié) |
attr | path:value sur un attribut, ou path!:value pour exclure. Répétez-le pour en mettre plusieurs. |
q | Du texte dans le message ou le domaine (sans tenir compte de la casse), ou un identifiant exact d'événement, d'utilisateur, de session ou d'installation. Les attributs ne sont pas cherchés : utilisez attr. |
limit | De 1 à 1000, 100 par défaut |
order | asc pour les plus anciens d'abord |
cursor | Le next_cursor de la réponse précédente, pour la page suivante |
category, message, user, session, install, env, platform, version, os,
device, locale, country et verified acceptent plusieurs valeurs séparées par |
(« est l'un de »), ou une liste précédée de ! (« n'est pas ») : os=26.4|27.2.0,
platform=!web. Une valeur d'attr accepte aussi |, et s'exclut avec ! après le chemin :
attr=plan!:free|trial. Les modèles d'appareil contiennent des virgules (iPhone18,1), d'où le
séparateur |.
# 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 réponse est {"events": [...], "next_cursor": "..."} ; next_cursor vaut null sur la
dernière page. Chaque événement a event_id, ts (millisecondes Unix), level, category,
message, user_id, install_id, session_id et attrs, plus les champs de la ressource
(app_id, app_version, app_build, os_name, os_version, device_model, locale,
environment, platform), country et verified_by : "server" quand l'événement est arrivé
avec une clé serveur, "app_attest" quand votre app Apple s'est authentifiée avec App Attest,
"key_attestation" quand votre app Android s'est authentifiée avec Key Attestation, "" quand il n'est pas vérifié (voir Événements vérifiés). La liste
omet le payload : demandez un événement précis pour l'obtenir.
Toutes les pages
Un curseur ne reprend que la requête dont il provient : envoyez-le avec les mêmes filtres.
Sans from ni to, la fenêtre avance avec l'horloge : fixez-les quand vous lisez plusieurs
pages. Ce script lit toutes les erreurs des 7 derniers jours, les plus anciennes d'abord, 1000 à
la fois (il faut 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
doneUn événement
GET /v1/events/{event_id}?ts={ts} renvoie un événement, avec tout son payload, sous la forme
{"event": {...}}. Passez le ts (millisecondes Unix) que la liste vous a donné : les événements
sont stockés par date, et l'identifiant seul obligerait à les parcourir tous.
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 champ que l'app n'a pas envoyé est une chaîne vide. payload est omis quand l'événement n'en
a pas.
Limites et erreurs
| Statut | Signification |
|---|---|
400 | Un paramètre est incorrect ; le corps de la réponse dit lequel. Par exemple : from qui n'est pas antérieur à to, une plage de plus de 400 jours, plus de 8 filtres attr, plus de 100 valeurs dans un filtre, un niveau inconnu, limit hors de 1 à 1000, un cursor invalide |
401 | Pas de clé, ou une clé inconnue ou révoquée |
403 | La clé ne peut pas lire (une clé d'ingestion) |
404 | Aucun événement avec cet identifiant et ce ts |
429 | Plus de 120 requêtes par minute pour cette clé (Retry-After: 60) ; le projet exécute déjà 4 requêtes à la fois, tableau de bord et clés confondus (Retry-After: 2) ; ou plus de 60 clés inconnues depuis votre adresse en 15 minutes |
500 | {"error":"something went wrong on the server"}. Une requête qui dure plus de 15 secondes se termine ainsi : réduisez la plage ou ajoutez des filtres |
Une erreur renvoie {"error": "..."}. Après un 429, attendez Retry-After avant de
réessayer.
Les réponses ne sont jamais mises en cache (Cache-Control: no-store). L'API n'a volontairement
pas de headers CORS : une clé de lecture n'a rien à faire dans un navigateur.