Consumption Events - List - Laburen Documentacion

curl --location --request GET 'https://dashboard.laburen.com/api/consumption-events?startDate=2025-01-01T00:00:00.000Z&endDate=2025-01-31T23:59:59.000Z&page=1&limit=20&orderBy=occurredAt_desc' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

const params = new URLSearchParams({
  startDate: '2025-01-01T00:00:00.000Z',
  endDate: '2025-01-31T23:59:59.000Z',
  page: '1',
  limit: '20',
  orderBy: 'occurredAt_desc',
});

const response = await fetch(`${apiUrl}/consumption-events?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

response = requests.get(
    f"{api_url}/consumption-events",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    params={
        "startDate": "2025-01-01T00:00:00.000Z",
        "endDate": "2025-01-31T23:59:59.000Z",
        "page": 1,
        "limit": 20,
        "orderBy": "occurredAt_desc",
    },
)

data = response.json()
print(data)

{
  "data": [
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "chat",
      "provider": "openai",
      "modelName": "gpt-4",
      "inputTokens": 1250,
      "outputTokens": 430,
      "units": null,
      "creditsCharged": 0.0285,
      "creditsChargedRaw": 0.0285,
      "billingCoefficient": 1.0,
      "unitType": "tokens",
      "amount": null,
      "occurredAt": "2025-01-15T14:32:10.000Z",
      "metadata": {},
      "conversationId": "clxxxxxxxxxxxxxxxxx",
      "messageId": "clxxxxxxxxxxxxxxxxx",
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    },
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "twilio_call",
      "provider": "twilio",
      "modelName": null,
      "inputTokens": 0,
      "outputTokens": 0,
      "units": 0,
      "creditsCharged": 0.5,
      "creditsChargedRaw": null,
      "billingCoefficient": 1.0,
      "unitType": "amount",
      "amount": { "value": 0.5, "type": "price" },
      "occurredAt": "2025-01-15T14:35:02.000Z",
      "metadata": {},
      "conversationId": null,
      "messageId": null,
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 154,
    "totalPages": 8
  }
}

GET

api

consumption-events

curl --location --request GET 'https://dashboard.laburen.com/api/consumption-events?startDate=2025-01-01T00:00:00.000Z&endDate=2025-01-31T23:59:59.000Z&page=1&limit=20&orderBy=occurredAt_desc' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

const params = new URLSearchParams({
  startDate: '2025-01-01T00:00:00.000Z',
  endDate: '2025-01-31T23:59:59.000Z',
  page: '1',
  limit: '20',
  orderBy: 'occurredAt_desc',
});

const response = await fetch(`${apiUrl}/consumption-events?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

response = requests.get(
    f"{api_url}/consumption-events",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    params={
        "startDate": "2025-01-01T00:00:00.000Z",
        "endDate": "2025-01-31T23:59:59.000Z",
        "page": 1,
        "limit": 20,
        "orderBy": "occurredAt_desc",
    },
)

data = response.json()
print(data)

{
  "data": [
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "chat",
      "provider": "openai",
      "modelName": "gpt-4",
      "inputTokens": 1250,
      "outputTokens": 430,
      "units": null,
      "creditsCharged": 0.0285,
      "creditsChargedRaw": 0.0285,
      "billingCoefficient": 1.0,
      "unitType": "tokens",
      "amount": null,
      "occurredAt": "2025-01-15T14:32:10.000Z",
      "metadata": {},
      "conversationId": "clxxxxxxxxxxxxxxxxx",
      "messageId": "clxxxxxxxxxxxxxxxxx",
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    },
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "twilio_call",
      "provider": "twilio",
      "modelName": null,
      "inputTokens": 0,
      "outputTokens": 0,
      "units": 0,
      "creditsCharged": 0.5,
      "creditsChargedRaw": null,
      "billingCoefficient": 1.0,
      "unitType": "amount",
      "amount": { "value": 0.5, "type": "price" },
      "occurredAt": "2025-01-15T14:35:02.000Z",
      "metadata": {},
      "conversationId": null,
      "messageId": null,
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 154,
    "totalPages": 8
  }
}

Este endpoint requiere autenticacion. Inclui tu API key en el header Authorization: Bearer <API_KEY>. Ver Autenticacion para mas detalles.

Returns a paginated list of consumption events for the authenticated organization. Use this endpoint to:

Browse individual consumption events with full detail
Filter by date range, agent, feature, provider, model, or conversation
Sort by date or credits charged
Paginate through large result sets

Query Parameters

Optional

string (ISO 8601)

Filter events that occurred on or after this date. Must be a valid ISO 8601 datetime string (e.g. 2025-01-01T00:00:00.000Z).

string (ISO 8601)

Filter events that occurred on or before this date. Must be a valid ISO 8601 datetime string. Must be greater than or equal to startDate if both are provided.

string

Filter events by a specific agent ID.

string

Filter events by feature name (e.g. chat, transcription).

string

Filter events by AI provider (e.g. openai, anthropic).

string

Filter events by model name (e.g. gpt-4, claude-3-opus).

string

Filter events by conversation ID.

integer

default:"1"

Page number for pagination. Minimum value: 1.

integer

default:"50"

Number of events per page. Minimum: 1, maximum: 100.

string

default:"occurredAt_desc"

Sort order for results. Valid values: occurredAt_asc, occurredAt_desc, creditsCharged_asc, creditsCharged_desc.

Response

array

List of consumption events.

Hide Consumption event object

string

Unique identifier of the consumption event.

string

ID of the organization that owns this event.

string

ID of the agent that generated this event.

string

The feature that triggered the consumption (e.g. chat, transcription).

string

The AI provider used (e.g. openai, anthropic).

string

The model name used (e.g. gpt-4, claude-3-opus).

integer

Number of input tokens consumed.

integer

Number of output tokens generated.

number

Input plus output tokens of the event. 0 for direct-amount events.

number

Final credits charged after applying the billing coefficient.

number

Cost before the billing coefficient. null for direct-amount events with amount.type = "price".

number

Multiplier applied to raw credits to calculate the final charge.

string

How the consumption was expressed: tokens (model token usage) or amount (a direct amount in USD/credits).

object | null

Only for unitType = "amount"; null otherwise.

Show Toggle object

number

Amount sent when the consumption was registered.

string

cost: the amount was a cost and the billing coefficient was applied. price: the amount was charged as-is (1 credit = 1 USD).

string (ISO 8601)

Timestamp when the consumption event occurred.

object

Additional metadata associated with the event.

string

ID of the conversation that generated this event (if applicable).

string

ID of the message that generated this event (if applicable).

object

Agent summary.

Show Agent object

string

Agent ID.

string

Agent name.

object

Pagination metadata.

Hide Pagination object

integer

Current page number.

integer

Number of items per page.

integer

Total number of matching events.

integer

Total number of pages.

Error Responses

Status Code	Type	Description
400	INVALID_REQUEST	`startDate` is after `endDate`
401	UNAUTHORIZED	Missing or invalid authentication

curl --location --request GET 'https://dashboard.laburen.com/api/consumption-events?startDate=2025-01-01T00:00:00.000Z&endDate=2025-01-31T23:59:59.000Z&page=1&limit=20&orderBy=occurredAt_desc' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

const params = new URLSearchParams({
  startDate: '2025-01-01T00:00:00.000Z',
  endDate: '2025-01-31T23:59:59.000Z',
  page: '1',
  limit: '20',
  orderBy: 'occurredAt_desc',
});

const response = await fetch(`${apiUrl}/consumption-events?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

response = requests.get(
    f"{api_url}/consumption-events",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    params={
        "startDate": "2025-01-01T00:00:00.000Z",
        "endDate": "2025-01-31T23:59:59.000Z",
        "page": 1,
        "limit": 20,
        "orderBy": "occurredAt_desc",
    },
)

data = response.json()
print(data)

{
  "data": [
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "chat",
      "provider": "openai",
      "modelName": "gpt-4",
      "inputTokens": 1250,
      "outputTokens": 430,
      "units": null,
      "creditsCharged": 0.0285,
      "creditsChargedRaw": 0.0285,
      "billingCoefficient": 1.0,
      "unitType": "tokens",
      "amount": null,
      "occurredAt": "2025-01-15T14:32:10.000Z",
      "metadata": {},
      "conversationId": "clxxxxxxxxxxxxxxxxx",
      "messageId": "clxxxxxxxxxxxxxxxxx",
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    },
    {
      "id": "clxxxxxxxxxxxxxxxxx",
      "organizationId": "clxxxxxxxxxxxxxxxxx",
      "agentId": "clxxxxxxxxxxxxxxxxx",
      "feature": "twilio_call",
      "provider": "twilio",
      "modelName": null,
      "inputTokens": 0,
      "outputTokens": 0,
      "units": 0,
      "creditsCharged": 0.5,
      "creditsChargedRaw": null,
      "billingCoefficient": 1.0,
      "unitType": "amount",
      "amount": { "value": 0.5, "type": "price" },
      "occurredAt": "2025-01-15T14:35:02.000Z",
      "metadata": {},
      "conversationId": null,
      "messageId": null,
      "agent": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "Support Bot"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 154,
    "totalPages": 8
  }
}

laburen API

Endpoints

Consumption Events - List

Query Parameters

Optional

Response

Error Responses

​Query Parameters

​Optional

​Response

​Error Responses

Query Parameters

Optional

Response

Error Responses