​

usage

orc usage get retrieves usage records aggregated into time buckets for the target Workspace. Group by model, API key ID, or endpoint group, and filter by API key IDs.

--start-time is a required inclusive RFC 3339 timestamp. --end-time is exclusive and must follow the start. The range cannot exceed 90 days. When omitted, the end defaults to the current time of each request; supply it explicitly to keep the range fixed while paging.

Retrieve a fixed interval.

Omitting grouping aggregates matching records within each bucket. Group fields whose stored value is null are omitted from results. Pass returned --cursor values unchanged, retaining the range, filters, and grouping.

--bucket-width accepts 1h or 1d, defaulting to 1d. Separate model, api_key_id, and endpoint_group values with commas for --group-by. --api-key-ids takes identifiers, never secret key values.

Inclusive lower bound for usage records, as an RFC 3339 timestamp. Required. The range from start_time to end_time cannot exceed 90 days.

Type: string. Required.

Exclusive upper bound for usage records. Must be after start_time. Defaults to the time of each request; set it explicitly to keep a fixed range across pages.

Type: string. Optional.

Time bucket width. Defaults to 1d.; enum: 1h|1d

Type: string. Optional.

Split each time bucket by one or more selected dimensions. Omit to aggregate all matching records in each bucket. Use repeated HTTP query parameters, for example group_by=model&group_by=endpoint_group. A grouping field is omitted from a result when its stored value is null.; csv of: model|api_key_id|endpoint_group

Type: string. Optional.

Include records attributed to any of these API key IDs. Omit for all keys in the workspace. Use repeated parameters, such as api_key_ids=key_a&api_key_ids=key_b; pass identifiers, never secret key values.; csv

Type: string. Optional.

Retrieve JSON by model.

Authenticate and select the target Workspace. Access to that Workspace is required.

The following global options can be used with orc usage:

For details and examples, see global options.