Beta
Usage Metrics

Aggregate Usage Metrics

Changed on

Aggregate usage metrics using the same filters as the regular list endpoint.

The authenticated organization is always applied as a filter.

get/api/v1/beta/usage-metrics/aggregate

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/beta/usage-metrics/aggregate
  • Auth: HTTP bearer

Query parameters

group_bystring[] required

Dimensions to group by: day, project_id, event_type, tier.

organization_idstring uuid required
project_idstring uuid nullable

Filter by project ID

user_idstring nullable

Filter by user ID

event_typesstring[] nullable

Filter by event types

daysstring[] nullable

Filter by specific days (YYYY-MM-DD)

day_on_or_beforestring nullable

Filter by days on or before this date (YYYY-MM-DD)

day_on_or_afterstring nullable

Filter by days on or after this date (YYYY-MM-DD)

event_aggregation_typestring nullable

Filter by event aggregation type

event_aggregation_keystring nullable

Filter by event aggregation key

credits_consumed_greater_than_or_equalnumber nullable

Filter by credits consumed greater than or equal to this value

Cookies

sessionstring nullable

Response

Successful Response

group_bystring[] required

Dimensions used to group metrics

Changes