Skip to content

feat(abtests): Add query params for GET /3/abtests/{id}/timeseries #4881

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.

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

Merged
merged 1 commit into from
May 26, 2025
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions specs/abtesting-v3/paths/timeseries.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@ get:
description: Retrieves timeseries for an A/B test by its ID.
parameters:
- $ref: '../common/parameters.yml#/ID'
- $ref: '../../common/parameters.yml#/StartDate'
- $ref: '../../common/parameters.yml#/EndDate'
- in: query
name: metric
description: List of metrics to retrieve. If not specified, all metrics are returned.
schema:
type: array
items:
type: string
enum:
- search_count
- tracked_search_count
- user_count
- tracked_user_count
- no_result_count
- add_to_cart_count
- purchase_count
- clicked_search_count
- converted_search_count
- click_through_rate
- conversion_rate
- add_to_cart_rate
- purchase_rate
- average_click_position
- revenue
example: ["search_count", "click_through_rate", "conversion_rate"]
responses:
'200':
description: OK
Expand All @@ -30,3 +56,5 @@ get:
$ref: '../../common/responses/MethodNotAllowed.yml'
'404':
$ref: '../../common/responses/IndexNotFound.yml'
'422':
$ref: '../../common/responses/UnprocessableEntity.yml'
Loading