Skip to content

Added route information for groups/groupby params#127

Open
akhilmmenon wants to merge 2 commits intomasterfrom
docs/dynamicgroupbys
Open

Added route information for groups/groupby params#127
akhilmmenon wants to merge 2 commits intomasterfrom
docs/dynamicgroupbys

Conversation

@akhilmmenon
Copy link

Added the route information for /analytics/groups/{groupBy} which 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.

@siddharthsambharia-portkey
Copy link
Collaborator

@akhilmmenon have we verified it on swagger validator?

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

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

@akhilmmenon
Copy link
Author

@narengogi I checked the code, and other than columns and include_total params, all the other params are shared across various endpoints, only those two are specific to groupby endpoint. So I have removed it from components/parameters and made them inline in the groupby route.

@siddharthsambharia-portkey I have validated the openAPI spec in Swagger Editor online and also validated it in the CLI
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants