Skip to main content

Interface: AIGatewayGroupOptions

Defined in: src/ai-gateway/telemetry-client.ts:158

Options for a logs/groups/{dimension} query.

Extends​

Properties​

columns?​

optional columns?: (
  | "cost"
  | "avg_latency"
  | "avg_tokens"
  | "total_tokens"
  | "success_rate"
  | "last_seen")[];

Defined in: src/ai-gateway/telemetry-client.ts:163

Extra columns to aggregate. The SDK rejects unsupported names before I/O; the API would silently drop them. See AI_GW_GROUP_COLUMNS for the valid set.

traceId?​

optional traceId?: string;

Defined in: src/ai-gateway/telemetry-client.ts:186

One trace ID. Serialized as SCM traceId, not the ignored upstream trace_id.

Inherited from​

AIGatewayChartOptions.traceId

metadata?​

optional metadata?: Record<string, string>;

Defined in: src/ai-gateway/telemetry-client.ts:188

Exact string-valued metadata matches. Serialized as JSON in the metadata query parameter.

Inherited from​

AIGatewayChartOptions.metadata

statusCodes?​

optional statusCodes?: number[];

Defined in: src/ai-gateway/telemetry-client.ts:190

One or more response status codes, matched with OR and serialized as SCM statusCode CSV.

Inherited from​

AIGatewayChartOptions.statusCodes

apiKeyIds?​

optional apiKeyIds?: string[];

Defined in: src/ai-gateway/telemetry-client.ts:192

One or more API-key UUIDs, matched with OR and serialized as SCM apiKeyIds CSV.

Inherited from​

AIGatewayChartOptions.apiKeyIds

aiOrgModels?​

optional aiOrgModels?: string[];

Defined in: src/ai-gateway/telemetry-client.ts:198

Provider/model pairs such as openai__gpt-5.6-terra, matched with OR. Each item must contain a provider and model separated by __, without commas or whitespace. Serialized as SCM aiOrgModel CSV; these are analytics identifiers, not inference routing.

Inherited from​

AIGatewayChartOptions.aiOrgModels

totalUnitsMin?​

optional totalUnitsMin?: number;

Defined in: src/ai-gateway/telemetry-client.ts:200

Inclusive minimum total tokens. A nonnegative safe integer; may equal the maximum.

Inherited from​

AIGatewayChartOptions.totalUnitsMin

totalUnitsMax?​

optional totalUnitsMax?: number;

Defined in: src/ai-gateway/telemetry-client.ts:202

Inclusive maximum total tokens. Zero is preserved, not omitted.

Inherited from​

AIGatewayChartOptions.totalUnitsMax

costMin?​

optional costMin?: number;

Defined in: src/ai-gateway/telemetry-client.ts:204

Inclusive minimum cost in cents; fractional values are preserved.

Inherited from​

AIGatewayChartOptions.costMin

costMax?​

optional costMax?: number;

Defined in: src/ai-gateway/telemetry-client.ts:206

Inclusive maximum cost in cents. Zero is preserved, not omitted.

Inherited from​

AIGatewayChartOptions.costMax

workspaceSlug​

workspaceSlug: string;

Defined in: src/ai-gateway/window.ts:7

Workspace slug, e.g. ws-main-a-349e0e. Required by every telemetry endpoint.

Inherited from​

AIGatewayChartOptions.workspaceSlug

days?​

optional days?: number;

Defined in: src/ai-gateway/window.ts:9

Rolling window size in days, counted back from now. Defaults to 7. Ignored if start is set.

Inherited from​

AIGatewayChartOptions.days

start?​

optional start?: Date;

Defined in: src/ai-gateway/window.ts:11

Explicit window start. Overrides days.

Inherited from​

AIGatewayChartOptions.start

end?​

optional end?: Date;

Defined in: src/ai-gateway/window.ts:13

Explicit window end. Defaults to now.

Inherited from​

AIGatewayChartOptions.end