Oxvel
FonctionsIntégrationsOffreDocumentationNouveautés
Se connecterCommencerOuvrir l'app
Documentation

Référence

Référence

API de capture

Pour envoyer des erreurs à Oxvel depuis n'importe quel langage, ou régler le script du navigateur.

L'adresse

POST https://oxvel.dev/api/ingest/ox_…

Pas de session, la clé du projet suffit. Le corps est un objet JSON, envoyé en application/json ou en text/plain. N'importe quel site peut appeler cette adresse. 100 000 caractères au plus.

Les champs

Tous sont facultatifs. Les textes trop longs sont coupés.

ChampContenu
typeLe type d'erreur, comme TypeError. Error par défaut.
messageLe message, 500 caractères au plus.
stackLa pile d'appels, telle que votre langage l'écrit.
levelfatal, error, warning ou info. error par défaut.
releaseLe commit ou la version en ligne.
environmentproduction, staging…
urlLa page ou la requête en cause.
methodLa méthode HTTP de la requête.
userL'identifiant de la personne touchée.
platformbrowser, node…
runtimeLe navigateur ou la version du moteur.
tagsUn objet clé et valeur, 20 entrées au plus.
breadcrumbsCe qui s'est passé avant. Les 10 derniers sont gardés.

Exemple

curl -X POST https://oxvel.dev/api/ingest/ox_… \
  -H "content-type: application/json" \
  -d '{"type":"TypeError","message":"cart is undefined","level":"error","release":"a1b2c3d"}'

Les réponses

204Reçu
400Clé ou JSON invalide
404Aucun projet n'a cette clé
413Corps trop gros
429Trop de nouvelles erreurs pour ce projet cette heure-ci

Au-delà de 30 nouvelles erreurs par heure, les erreurs déjà connues continuent d'être comptées.

Le script du navigateur

data-keyLa clé du projet
data-releaseLe commit déployé
data-environmentproduction par défaut
Oxvel.capture(err, options)Envoie une erreur à la main. options peut contenir level et tags.
Oxvel.setUser(id)Relie les erreurs suivantes à une personne

Le script garde les 20 derniers événements (erreurs et avertissements de la console, changements de page). Il envoie 25 erreurs au plus par chargement de page, et la même erreur une seule fois si elle revient dans la seconde.

Sur cette page