Get cost histogram by dimension

Returns time-bucketed cost data grouped by an arbitrary dimension (provider, team_id, customer_id, user_id, business_unit_id). The dimension is supplied via the required dimension query parameter.

GET /api/logs/histogram/cost/by-dimension

Error

A valid request URL is required to generate request examples

200

{
  "buckets": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "total_cost": 123,
      "by_dimension": {}
    }
  ],
  "bucket_size_seconds": 123,
  "dimension_values": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

dimension · enum<string> · required

Grouping dimension Grouping dimension for dimension-aware histograms. Used by the /api/logs/histogram/{cost,tokens,latency}/by-dimension endpoints.

Available options: provider, team_id, customer_id, user_id, business_unit_id

providers · string

Comma-separated list of providers to filter by

models · string

Comma-separated list of models to filter by

status · string

Comma-separated list of statuses to filter by

objects · string

Comma-separated list of object types to filter by

selected_key_ids · string

Comma-separated list of selected key IDs to filter by

virtual_key_ids · string

Comma-separated list of virtual key IDs to filter by

routing_rule_ids · string

Comma-separated list of routing rule IDs to filter by

routing_engine_used · string

Comma-separated list of routing engines to filter by

start_time · string<date-time>

Start time filter (RFC3339 format)

end_time · string<date-time>

End time filter (RFC3339 format)

min_latency · number

Minimum latency filter

max_latency · number

Maximum latency filter

min_tokens · integer

Minimum tokens filter

max_tokens · integer

Maximum tokens filter

min_cost · number

Minimum cost filter

max_cost · number

Maximum cost filter

missing_cost_only · boolean

Only show logs with missing cost

content_search · string

Search in request/response content

Response

200

application/json

Dimension cost histogram retrieved successfully

Dimension-grouped cost histogram result

buckets · object[]

Show child attributes

bucket_size_seconds · integer<int64>

dimension · enum<string>

Grouping dimension for dimension-aware histograms. Used by the /api/logs/histogram/{cost,tokens,latency}/by-dimension endpoints.

Available options: provider, team_id, customer_id, user_id, business_unit_id

dimension_values · string[]