Passer au contenu principal
Utilisez l’API de compte pour lire l’utilisation, l’état des quotas, l’historique d’utilisation et l’état de l’abonnement, et pour vous déconnecter. Les lectures du compte utilisent un jeton bearer de compte ou la session du navigateur. N’utilisez jamais une clé d’ingestion de projet pour une requête de compte. N’utilisez jamais un identifiant de compte comme configuration du SDK ou de l’ingestion. Les erreurs utilisent l’enveloppe d’erreur standard de l’API. Une lecture sans authentification de compte valide renvoie 401 avec code: "unauthorized". N’affichez pas cet échec comme une utilisation nulle, un graphique vide ou un forfait gratuit. Une méthode non prise en charge renvoie 405 avec code: "method_not_allowed", et next indique la requête prise en charge. L’API de compte indique l’utilisation de la télémétrie, pas des montants. Elle n’indique ni frais, ni factures, ni état de paiement.

Utilisation du compte

GET /api/account/usage est le point de terminaison de référence pour l’utilisation et les quotas. Utilisez-le pour les totaux d’utilisation, l’heure de réinitialisation, l’état des quotas et les répartitions par projet et par flux de télémétrie. Ne calculez pas l’utilisation à partir de fichiers du SDK, de fichiers de la CLI ou de compteurs côté client. La commande CLI logbrew usage lit ce point de terminaison. Consultez la référence de la CLI.
Exemple de réponse avec des valeurs synthétiques. Ce compte gratuit a 1 projet et n’a envoyé que des logs pendant la période en cours :

Événements abandonnés par les SDK

Envoyez response_version=2 pour obtenir aussi sdk_dropped_events. Sans ce paramètre, ou avec response_version=1, la réponse ne contient pas ce champ.
sdk_dropped_events liste les événements que les SDK ont signalés comme abandonnés avant l’envoi pendant la période en cours, par exemple parce que la file d’attente du client était pleine. Il y a 1 ligne par projet et par motif :
Les événements abandonnés ne sont jamais arrivés chez LogBrew. Ils ne sont pas facturés et ne comptent pas dans usage, by_project ou by_stream. Le tableau est vide quand aucun SDK n’a signalé d’abandon. Le tableau compte aussi les enregistrements OTLP que LogBrew a rejetés, avec le motif otlp_rejected_record, ou usage_limit_exceeded à la limite du forfait. Ces enregistrements sont arrivés chez LogBrew, mais LogBrew ne les a pas stockés. Ils ne sont pas facturés. Consultez OpenTelemetry (OTLP).

Offre des nouveaux comptes

Les comptes plus anciens ont reçu gratuitement les quotas de Pro pendant 6 mois, comptés depuis l’inscription ou, pour les comptes qui existaient le 2026-10-22, depuis cette date. Ils gardent l’offre jusqu’à son ends_at. Les nouveaux comptes commencent avec Free et ne reçoivent pas cette offre. Pro inclut un essai gratuit de 1 mois. Ajoutez une carte pour le démarrer. Pro se renouvelle ensuite chaque mois jusqu’à votre résiliation. Envoyez response_version=3 pour obtenir aussi offer. Les versions 1 et 2 n’ont pas ce champ. La version 3 a aussi sdk_dropped_events.
offer vaut null quand aucune offre n’est active. Sinon, il contient ces champs :
Tant qu’une offre est active, limits.retention_days, state, limit, percent_used et next_action utilisent les quotas les plus élevés entre le forfait propre du compte et l’offre. plan continue d’afficher le forfait propre du compte. Après ends_at, le compte utilise de nouveau son forfait propre. Les versions 1 et 2 suivent les mêmes quotas, mais n’affichent pas l’offre. L’aperçu de facturation, GET /api/billing/overview, a le même champ offer. Il a aussi pro_trial_available, qui vaut true quand un paiement Pro démarre l’essai gratuit.

États des quotas

Utilisez state pour la condition principale. limit vaut null uniquement quand state vaut ok. Ce tableau s’applique aux versions 2 et 3. La version 1, par défaut, a 2 différences : warning vaut aussi true dans l’état blocked, et dans l’état warning, next_action.target vaut account_usage. next_action.state, next_action.limit et next_action.reset_at reprennent les valeurs de premier niveau. Les valeurs de next_action.code incluent aussi check_usage_limits avec la cible account_usage. Si un client reçoit cette paire, lisez de nouveau l’utilisation et affichez next. LogBrew mesure chaque type de télémétrie par rapport à son propre quota. limit les regroupe :
  • events couvre les événements de problèmes et les spans de trace.
  • bytes couvre les octets de logs et les octets de métriques.
Si un quota est bloqué et qu’un autre est en avertissement, limit indique le quota bloqué. L’état warning commence quand l’utilisation atteint warning_threshold d’un quota. L’état blocked commence quand l’utilisation atteint le quota. Le texte de next peut changer, par exemple quand les forfaits ne sont pas en vente. Les valeurs de next_action ne changent pas. Localisez à partir de next_action. N’analysez pas next. Une limite d’utilisation du compte n’est pas une limite de débit de l’API. Quand l’ingestion dépasse un quota, la requête d’ingestion renvoie 429 avec usage_limit_exceeded, et le corps ajoute limit et reset_at. Dans cette erreur, limit indique le quota exact : issue_events, log_bytes, metric_bytes ou trace_spans. LogBrew refuse la requête entière. N’envoyez plus ce type de télémétrie avant reset_at ou avant un changement de forfait. Quand un client envoie trop de requêtes, l’API renvoie rate_limited. Consultez Erreurs de l’API. La réponse est un instantané. Lisez-la de nouveau après une modification du compte.
GET /api/logs/usage est une réponse de compatibilité héritée pour le mobile, avec bytes_used, limit_bytes et month. Utilisez GET /api/account/usage pour les nouvelles intégrations.

Historique d’utilisation

GET /api/account/usage/history renvoie un nombre borné d’intervalles d’utilisation, complétés par des zéros, pour les graphiques et les rapports. Donnez à interval une valeur prise en charge. Si vous omettez interval, l’API utilise monthly. La route n’accepte aucun autre paramètre de requête.
Cette réponse yearly utilise des données synthétiques pour une requête faite en juin 2026. Toute l’utilisation a eu lieu en juin :
Utilisez current.reset_at pour la réinitialisation du quota. N’utilisez pas la fin de la période de l’historique. current n’est pas la somme des intervalles, et ses dates peuvent différer de celles de la période de l’historique. Le dernier intervalle contient la période civile en cours, qui n’est pas terminée. Sa date de fin future ne signifie pas que LogBrew a mesuré une utilisation future. Un intervalle rempli de zéros signifie que LogBrew n’a compté aucune utilisation dans cet intervalle. Dans un intervalle, usage.projects compte les projets qui ont une utilisation dans cet intervalle. N’additionnez pas ces nombres pour obtenir le nombre de projets. Utilisez current.usage.projects pour le nombre de projets possédés. Tracez les événements et les octets dans des séries distinctes, car leurs unités diffèrent. Les intervalles contiennent l’utilisation, pas un coût. N’intitulez pas le graphique « dépenses », « factures » ou « requêtes API ». Un intervalle non pris en charge renvoie 422 :
Un paramètre de requête inconnu renvoie aussi 422 avec validation_failed.

Forfaits et quotas

GET /api/billing/catalog liste les forfaits. Il ne demande aucune authentification. Chaque forfait inclut toutes les fonctionnalités. Chaque forfait a un nombre illimité de membres et de projets. Les forfaits diffèrent par le volume et la durée de conservation. Les quotas se réinitialisent chaque mois de facturation. 1 Go correspond à 1 000 000 000 octets. Vous achetez Pro et Business par le paiement en ligne, et checkout_available vaut true. Pour Enterprise, écrivez à l’adresse quote_email du forfait pour obtenir un devis. Un compte avec une offre des nouveaux comptes active reçoit gratuitement les quotas de Pro jusqu’à la fin de l’offre. Le catalogue et l’aperçu de facturation utilisent les valeurs tier developer, team, business et enterprise. Les réponses d’utilisation et d’abonnement utilisent free, pro et scale. Les forfaits Business et Enterprise sont tous deux scale.
La réponse liste les forfaits dans cet ordre. Cet exemple montre le forfait Pro :

Conservation des données

La durée de conservation est le nombre de jours pendant lesquels LogBrew conserve la télémétrie d’un compte. La durée de conservation du compte est la plus longue entre celle de son forfait et celle d’une offre des nouveaux comptes active. Un contrat Enterprise fixe sa propre durée de conservation.
  • Les lectures ne renvoient que la télémétrie comprise dans la durée de conservation.
  • Chaque jour, LogBrew supprime la télémétrie du compte plus ancienne que la durée de conservation plus 1 jour.
  • Après un passage à un forfait inférieur ou la fin d’une offre, la durée de conservation la plus courte s’applique à la prochaine suppression quotidienne.

État de l’abonnement

GET /api/account/subscription est en lecture seule. Utilisez-le pour décider s’il faut activer les contrôles d’organisation. Utilisez le point de terminaison d’utilisation pour l’état des quotas.
Un compte gratuit renvoie cette réponse. L’account_id est synthétique :
La valeur 9007199254740991 dans members_per_organization et projects_per_organization signifie illimité. C’est le plus grand entier que les clients JSON lisent exactement. Affichez « Illimité » pour cette valeur. Seul le nombre d’organisations qu’un compte possède peut bloquer la création d’une organisation. next est un texte d’affichage. Affichez le texte renvoyé, ou localisez à partir de next_action. Ne codez pas en dur un nom de forfait à partir de next. Valeurs des énumérations : L’API ne renvoie pas les blocages subscription_required et subscription_inactive. Chaque blocage a une paire next_action : Les valeurs de niveau de forfait sont des identifiants, pas des noms d’affichage. Gardez-les inchangées dans un client localisé. Vérifiez organization_creation_allowed avant d’activer la création d’organisations. Ce point de terminaison ne crée pas d’organisation, n’envoie pas d’invitations, ne modifie pas les rôles et ne modifie pas la facturation.

Invitations à une organisation

Un propriétaire ou un administrateur de l’organisation invite un collègue par e-mail. LogBrew envoie au collègue un e-mail avec un lien vers l’invitation. L’invitation expire après 7 jours. Ces points de terminaison montrent l’invitation au compte invité avant qu’il l’accepte. Une invitation est la vôtre lorsqu’elle a été envoyée à l’adresse e-mail de votre compte ou d’une méthode de connexion liée à votre compte. Listez vos invitations en attente :
La réponse liste les invitations en attente qui n’ont pas expiré, de la plus récente à la plus ancienne, jusqu’à 100. Les ID sont synthétiques :
Lisez une invitation à partir de son lien :
La réponse est une invitation avec les mêmes champs. Seul le compte invité peut lire une invitation. Un autre compte, un ID d’invitation inconnu et une organisation inconnue reçoivent tous le même 404 avec code: "not_found". Connectez-vous avec l’adresse e-mail invitée, puis réessayez. Pour accepter, envoyez POST à accept_path avec le compte invité. Une deuxième acceptation par le même compte renvoie la même appartenance. Une invitation expirée ou révoquée renvoie 422 avec code: "invite_invalid". Demandez une nouvelle invitation à un propriétaire ou à un administrateur. Un compte peut envoyer au maximum 20 invitations par jour UTC, toutes organisations confondues. L’invitation suivante renvoie 429 avec code: "invitation_limit_exceeded" et limit: "invitations_per_inviter_per_day". Attendez reset_at. Voir Erreurs de l’API.

Se déconnecter

Choisissez le plus petit périmètre qui correspond à la tâche. Ces points de terminaison ne suppriment pas le compte ni ses projets, ne renouvellent pas les clés d’ingestion et ne révoquent pas l’autorisation accordée à un fournisseur de connexion tiers.

Une connexion d’application ou de CLI

Envoyez la requête depuis le client qui détient le jeton d’actualisation. Définissez Content-Type: application/json :
Ne demandez jamais à une personne ou à un agent d’afficher ou de coller un jeton d’actualisation. Une réponse réussie renvoie 200 :
Cette requête révoque une famille de jetons d’actualisation. LogBrew refuse les actualisations suivantes pour cette connexion. Les autres connexions du compte ne changent pas. Un jeton d’accès que le client possède déjà reste valide jusqu’à son expiration. Si les identifiants du compte risquent d’être exposés, utilisez Toutes les connexions LogBrew. Après la réponse, le client supprime ses identifiants locaux. Si vous renvoyez le même jeton d’actualisation valide, la réponse est le même 200. Si le jeton est invalide ou expiré, ou s’il s’agit d’un jeton d’accès, la réponse est 401 avec code: "unauthorized" et next_action.code: "authorize_request". Supprimez aussi les identifiants locaux dans ce cas. logbrew logout utilise ce point de terminaison.

Toutes les connexions LogBrew

Cette requête déconnecte tous les clients du compte. Obtenez l’accord du propriétaire du compte avant qu’un agent l’envoie.
Une réponse réussie renvoie 200 :
revoked_before est inclus et a une précision à la milliseconde. LogBrew refuse les jetons d’accès, les sessions de navigateur et les jetons d’actualisation issus d’une connexion faite à ce moment ou avant. Un jeton actualisé plus tard à partir d’une telle connexion est aussi refusé. Les sessions de flux en direct en cours se terminent, et la réponse efface le cookie de session du navigateur. Une connexion faite après ce moment reste valide. Chaque client doit supprimer ses identifiants LogBrew locaux et se reconnecter. Ne vous reconnectez pas pour répéter cette requête automatiquement. Une nouvelle requête révoque aussi la nouvelle connexion. Si la réponse est perdue, n’affirmez pas que toutes les connexions ont été révoquées. Un 401 ultérieur obtenu avec un ancien identifiant ne remplace pas la réponse de succès. Pour d’autres étapes de correction, lisez Sécuriser un compte compromis.

Session du navigateur

POST /api/auth/web/logout efface le cookie logbrew_session du navigateur et renvoie 204 No Content sans corps. Appelez-le depuis le navigateur. Ne copiez pas le cookie de session dans une commande. Cette requête ne déconnecte pas les autres clients et ne révoque pas une copie de la valeur du cookie. Pour révoquer toutes les sessions, utilisez Toutes les connexions LogBrew.

Corriger une erreur de déconnexion

Pour les routes de télémétrie, les filtres et la pagination, lisez l’API de télémétrie.