Skip to main content
Usa la API de cuenta para leer el uso, el estado de la cuota, el historial de uso y el estado de la suscripción, y para cerrar sesión. Las lecturas de la cuenta usan un token bearer de cuenta o la sesión del navegador. Nunca uses una clave de ingesta del proyecto en una solicitud de cuenta. Nunca uses una credencial de cuenta en la configuración del SDK o de la ingesta. Los errores usan el sobre de error estándar de la API. Una lectura sin una autenticación de cuenta válida devuelve 401 con code: "unauthorized". No muestres ese fallo como uso cero, un gráfico vacío o un plan gratuito. Un método no admitido devuelve 405 con code: "method_not_allowed", y next indica la solicitud admitida. La API de cuenta informa del uso de telemetría, no de dinero. No informa de cargos, facturas ni del estado de los pagos.

Uso de la cuenta

GET /api/account/usage es el endpoint canónico de uso y cuota. Úsalo para los totales de uso, la hora de reinicio, el estado de la cuota y los desgloses por proyecto y por flujo de telemetría. No calcules el uso a partir de archivos del SDK, archivos de la CLI ni contadores del cliente. El comando de la CLI logbrew usage lee este endpoint. Consulta Referencia de la CLI.
Respuesta de ejemplo con valores sintéticos. Esta cuenta gratuita tiene 1 proyecto y solo envió logs en el periodo actual:

Eventos descartados por los SDK

Envía response_version=2 para recibir también sdk_dropped_events. Sin este parámetro, o con response_version=1, la respuesta no incluye este campo.
sdk_dropped_events muestra los eventos que los SDK informaron como descartados antes de enviarlos en el período actual, por ejemplo porque la cola del cliente estaba llena. Hay 1 fila por cada proyecto y motivo:
Los eventos descartados nunca llegaron a LogBrew. No se facturan y no cuentan en usage, by_project ni by_stream. El array está vacío cuando ningún SDK informó descartes.

Estados de la cuota

Usa state para la rama principal. limit es null solo cuando state es ok. next_action.state, next_action.limit y next_action.reset_at repiten los valores del nivel superior. Los valores de next_action.code también incluyen check_usage_limits con el destino account_usage. Si un cliente recibe ese par, vuelve a leer el uso y muestra next. LogBrew mide cada tipo de telemetría con su propia cuota. limit las agrupa:
  • events cubre los eventos de incidencias y los spans de trazas.
  • bytes cubre los bytes de logs y los bytes de métricas.
Si una cuota está bloqueada y otra está en aviso, limit indica la cuota bloqueada. El estado warning empieza cuando el uso alcanza el warning_threshold de una cuota. El estado blocked empieza cuando el uso alcanza la cuota. El texto de next puede cambiar, por ejemplo cuando los planes no están a la venta. Los valores de next_action no cambian. Localiza a partir de next_action. No analices next. Un límite de uso de la cuenta no es un límite de solicitudes de la API. Cuando la ingesta supera una cuota, la solicitud de ingesta devuelve 429 con usage_limit_exceeded, y el cuerpo añade limit y reset_at. En ese error, limit indica la cuota exacta: issue_events, log_bytes, metric_bytes o trace_spans. LogBrew rechaza la solicitud completa. No vuelvas a enviar ese tipo de telemetría hasta reset_at o hasta que cambie el plan. Cuando un cliente envía demasiadas solicitudes, la API devuelve rate_limited. Consulta Errores de la API. La respuesta es una instantánea. Vuelve a leerla después de un cambio en la cuenta.
GET /api/logs/usage es una respuesta heredada de compatibilidad móvil con bytes_used, limit_bytes y month. Usa GET /api/account/usage en las integraciones nuevas.

Historial de uso

GET /api/account/usage/history devuelve intervalos de uso limitados y rellenados con ceros para gráficos e informes. Define interval con uno de los valores admitidos. Si omites interval, la API usa monthly. La ruta no acepta ninguna otra clave de consulta.
Esta respuesta yearly usa datos sintéticos para una solicitud de junio de 2026. Todo el uso ocurrió en junio:
Usa current.reset_at para el reinicio de la cuota. No uses el final de la ventana del historial. current no es la suma de los intervalos, y sus fechas pueden ser distintas de las de la ventana. El último intervalo contiene el periodo natural actual, que no está completo. Su hora de fin futura no significa que LogBrew midiera un uso futuro. Un intervalo con ceros significa que LogBrew no contó uso en ese intervalo. En un intervalo, usage.projects cuenta los proyectos que tienen uso en ese intervalo. No sumes estos recuentos para obtener el número de proyectos. Usa current.usage.projects para el número de proyectos propios. Representa los eventos y los bytes como series distintas, porque usan unidades distintas. Los intervalos contienen uso, no costes. No etiquetes el gráfico como gasto, facturas o solicitudes a la API. Un intervalo no admitido devuelve 422:
Una clave de consulta desconocida también devuelve 422 con validation_failed.

Estado de la suscripción

GET /api/account/subscription es de solo lectura. Úsalo para decidir si activas los controles de los planes de pago o de la organización. Usa el endpoint de uso para el estado de la cuota.
Una cuenta gratuita devuelve esta respuesta. El account_id es sintético:
next es un texto para mostrar. Cambia cuando los planes de pago están o no a la venta. Muestra el texto devuelto o localiza a partir de next_action. No fijes en el código un nombre de plan sacado de next. Valores de enumeración: Cada bloqueo tiene un par next_action: Los valores de nivel son identificadores, no nombres para mostrar. No los cambies en un cliente localizado. Una cuenta de pago puede estar bloqueada igualmente. Revisa organization_creation_allowed antes de activar la creación de organizaciones. Este endpoint no crea organizaciones, no envía invitaciones, no cambia roles ni cambia la facturación.

Cerrar sesión

Elige el alcance más pequeño que corresponda a la tarea. Estos endpoints no eliminan la cuenta ni sus proyectos, no rotan las claves de ingesta y no revocan el permiso de un proveedor de inicio de sesión externo.

La sesión de una app o de la CLI

Envía la solicitud desde el cliente que tiene el token de actualización. Define Content-Type: application/json:
Nunca pidas a una persona o a un agente que imprima o pegue un token de actualización. Una respuesta correcta es 200:
Esto revoca una familia de tokens de actualización. LogBrew rechaza las actualizaciones posteriores de esa sesión. Las demás sesiones de la cuenta no cambian. Un token de acceso que ya tiene el cliente sigue siendo válido hasta que caduque. Si las credenciales de la cuenta pueden estar expuestas, usa Todas las sesiones de LogBrew. Después de la respuesta, el cliente elimina sus credenciales locales. Si vuelves a enviar el mismo token de actualización válido, la respuesta es el mismo 200. Si el token no es válido, caducó o es un token de acceso, la respuesta es 401 con code: "unauthorized" y next_action.code: "authorize_request". Elimina también las credenciales locales en ese caso. logbrew logout usa este endpoint.

Todas las sesiones de LogBrew

Esta solicitud cierra la sesión de todos los clientes de la cuenta. Obtén la aprobación del propietario de la cuenta antes de que un agente la envíe.
Una respuesta correcta es 200:
revoked_before es inclusivo y tiene precisión de milisegundos. LogBrew rechaza los tokens de acceso, las sesiones del navegador y los tokens de actualización de un inicio de sesión hecho en ese momento o antes. También rechaza un token actualizado más tarde a partir de ese inicio de sesión. Las sesiones de actividad en vivo en curso terminan, y la respuesta borra la cookie de sesión del navegador. Un inicio de sesión posterior a ese momento sigue siendo válido. Cada cliente debe eliminar sus credenciales locales de LogBrew y volver a iniciar sesión. No vuelvas a iniciar sesión y repitas esta solicitud automáticamente. Una solicitud nueva también revoca el nuevo inicio de sesión. Si se pierde la respuesta, no informes de que se revocaron todas las sesiones. Un 401 posterior de una credencial antigua no sustituye a la respuesta correcta. Para más pasos de recuperación, lee Protege una cuenta comprometida.

Sesión del navegador

POST /api/auth/web/logout borra la cookie logbrew_session del navegador y devuelve 204 No Content sin cuerpo. Llámalo desde el navegador. No copies la cookie de sesión en un comando. Esta solicitud no cierra la sesión de otros clientes ni revoca una copia del valor de la cookie. Para revocar todas las sesiones, usa Todas las sesiones de LogBrew.

Recupérate de un error al cerrar sesión

Para las rutas, los filtros y la paginación de telemetría, lee la API de telemetría.