Skip to content

Added route information for groups/groupby params #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhilmmenon wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added route information for groups/groupby params #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
516ddce
Added route information for groups/groupby params
Mar 5, 2026
5834207
Moved columns and include_total from components/parameters
Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20100,6 +20100,165 @@ paths:
- object
- data

/analytics/groups/{groupBy}:
servers: *ControlPlaneServers
get:
operationId: getAnalyticsGroupedData
tags:
- Analytics > Groups
summary: Get grouped analytics data by a specified dimension.
description: |
Returns analytics data grouped by the specified dimension. Supports configurable metric columns,
filtering by metadata, time range, and other standard analytics filters. Use the `columns` parameter
to specify which metrics to include in the response.
parameters:
- name: groupBy
Copy link
Member

@narengogi narengogi Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you will need to add query parameters here as well like this (replacew with the query params for this route)
- name: current_page
in: query
schema:
type: integer
example: "0"
- name: name
in: query
schema:
type: string
example: "workspace"
description: "Workspace name to filter results, case sensitive"

can you remove them from the bottom, those are shared query params for all the analytics routes, I think these query params are only for this route, please check the code I might be wrong

in: path
required: true
schema:
type: string
enum:
- ai_service
- model
- status_code
- api_key
- config
- workspace
- provider
- prompt
description: |
The dimension to group analytics data by.
- `ai_service` - Group by AI provider/service
- `model` - Group by AI model
- `status_code` - Group by response status code
- `api_key` - Group by API key
- `config` - Group by config
- `workspace` - Group by workspace
- `provider` - Group by virtual key / provider
- `prompt` - Group by prompt slug
- $ref: "#/components/parameters/WorkspaceSlug"
- $ref: "#/components/parameters/TimeOfGenerationMin"
- $ref: "#/components/parameters/TimeOfGenerationMax"
- $ref: "#/components/parameters/TotalUnitsMin"
- $ref: "#/components/parameters/TotalUnitsMax"
- $ref: "#/components/parameters/CostMin"
- $ref: "#/components/parameters/CostMax"
- $ref: "#/components/parameters/PromptTokenMin"
- $ref: "#/components/parameters/PromptTokenMax"
- $ref: "#/components/parameters/CompletionTokenMin"
- $ref: "#/components/parameters/CompletionTokenMax"
- $ref: "#/components/parameters/StatusCode"
- $ref: "#/components/parameters/WeightedFeedbackMin"
- $ref: "#/components/parameters/WeightedFeedbackMax"
- $ref: "#/components/parameters/VirtualKeys"
- $ref: "#/components/parameters/Configs"
- $ref: "#/components/parameters/ApiKeyIds"
- $ref: "#/components/parameters/CurrentPage"
- $ref: "#/components/parameters/PageSize"
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/AiOrgModel"
- $ref: "#/components/parameters/TraceId"
- $ref: "#/components/parameters/SpanId"
- $ref: "#/components/parameters/PromptSlug"
- name: columns
in: query
schema:
type: string
description: Comma separated list of metric columns to include in the response. Available columns are requests, cost, total_tokens, avg_tokens, avg_input_tokens, avg_output_tokens, avg_latency, p95_latency, p99_latency, success_rate, error_count, cache_hit_rate, last_seen, first_seen. The 'requests' column is always included.
example: requests,cost,avg_latency,success_rate
- $ref: "#/components/parameters/OrderBy"
- $ref: "#/components/parameters/OrderByType"
- name: include_total
in: query
schema:
type: string
enum:
- "true"
- "false"
description: Whether to include grand totals in the response
responses:
"200":
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
object:
type: string
enum: [list]
total:
type: integer
description: Total records present across all pages
data:
type: array
items:
type: object
properties:
group_key:
type: string
description: The value of the grouped dimension (e.g., model name, provider name)
requests:
type: integer
description: Total number of requests
cost:
type: number
description: Total cost in cents
total_tokens:
type: integer
description: Total tokens across all requests
avg_tokens:
type: number
description: Average tokens per request
avg_input_tokens:
type: number
description: Average input tokens per request
avg_output_tokens:
type: number
description: Average output tokens per request
avg_latency:
type: number
description: Average latency in milliseconds
p95_latency:
type: number
description: 95th percentile latency in milliseconds
p99_latency:
type: number
description: 99th percentile latency in milliseconds
success_rate:
type: number
description: Percentage of successful requests
error_count:
type: integer
description: Total number of errored requests
cache_hit_rate:
type: number
description: Percentage of requests served from cache
last_seen:
type: string
format: date-time
description: Timestamp of the most recent request
first_seen:
type: string
format: date-time
description: Timestamp of the earliest request
object:
type: string
description: The type of object being returned
enum: [analytics-group]
required:
- group_key
- requests
required:
- total
- object
- data

/model-configs/pricing/{provider}/{model}:
servers: *PublicServers
get:
Expand Down Expand Up @@ -20473,6 +20632,7 @@ components:
type: string
description: Comma separated prompt slugs
example: prompt-slug-1,prompt-slug-2

PortkeyTraceId:
in: header
name: x-portkey-trace-id
Expand Down
Loading