Uso y Facturacion

Resumenes de uso de la API, cuotas y desglose por clave. Monitorea tu consumo, rastrea excedentes y gestiona tu facturacion en todas tus claves API.

Endpoints

Metodo	Endpoint	Descripcion	Scope
GET	/usage/summary	Obtener resumen de uso del periodo de facturacion actual	usage:read
GET	/usage/details	Obtener registros de uso detallados con paginacion	usage:read
GET	/usage/by-key	Obtener desglose de uso por clave API	usage:read

Parametros de Consulta

`GET /usage/summary`

Parametro	Tipo	Descripcion
billingPeriod	string	Periodo de facturacion en formato YYYY-MM (por defecto: periodo actual)

`GET /usage/details`

Parametro	Tipo	Descripcion
billingPeriod	string	Periodo de facturacion en formato YYYY-MM (por defecto: periodo actual)
page	integer	Numero de pagina (por defecto: 1)
pageSize	integer	Elementos por pagina (por defecto: 25, maximo: 100)

`GET /usage/by-key`

Parametro	Tipo	Descripcion
billingPeriod	string	Periodo de facturacion en formato YYYY-MM (por defecto: periodo actual)

Ejemplos de Solicitudes

Obtener resumen de uso del periodo actual:

curl https://api.auralytik.com/v1/usage/summary \
  -H "Authorization: Bearer YOUR_API_KEY"

Obtener uso de un periodo de facturacion especifico:

curl https://api.auralytik.com/v1/usage/details?billingPeriod=2024-01&page=1&pageSize=50 \
  -H "Authorization: Bearer YOUR_API_KEY"

Obtener desglose de uso por clave:

curl https://api.auralytik.com/v1/usage/by-key?billingPeriod=2024-01 \
  -H "Authorization: Bearer YOUR_API_KEY"

Respuesta de Resumen

{
  "billingPeriod": "2024-01",
  "tier": "professional",
  "usage": {
    "calls": {
      "used": 8420,
      "included": 10000,
      "overage": 0
    },
    "webhooks": {
      "used": 15200,
      "included": 50000,
      "overage": 0
    },
    "storage_gb": {
      "used": 12.4,
      "included": 25.0,
      "overage": 0
    }
  }
}

Respuesta de Desglose por Clave

{
  "billingPeriod": "2024-01",
  "keys": [
    {
      "keyId": "ak_prod_abc123",
      "name": "Production API Key",
      "calls": 6100,
      "lastUsedAt": "2024-01-31T23:45:00Z"
    },
    {
      "keyId": "ak_stg_def456",
      "name": "Staging API Key",
      "calls": 2320,
      "lastUsedAt": "2024-01-31T18:20:00Z"
    }
  ]
}

Alertas de uso y facturas proximamente

APIs de alertas de umbral de uso, consulta de facturas y proyeccion de costos estan en desarrollo.

Solicitar Acceso API