Skip to content

Commit a7654a2

Browse files
feat(abtests): Add query params for GET /3/abtests/{id}/timeseries (#4881)
1 parent 0ee171f commit a7654a2

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

specs/abtesting-v3/paths/timeseries.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,32 @@ get:
88
description: Retrieves timeseries for an A/B test by its ID.
99
parameters:
1010
- $ref: '../common/parameters.yml#/ID'
11+
- $ref: '../../common/parameters.yml#/StartDate'
12+
- $ref: '../../common/parameters.yml#/EndDate'
13+
- in: query
14+
name: metric
15+
description: List of metrics to retrieve. If not specified, all metrics are returned.
16+
schema:
17+
type: array
18+
items:
19+
type: string
20+
enum:
21+
- search_count
22+
- tracked_search_count
23+
- user_count
24+
- tracked_user_count
25+
- no_result_count
26+
- add_to_cart_count
27+
- purchase_count
28+
- clicked_search_count
29+
- converted_search_count
30+
- click_through_rate
31+
- conversion_rate
32+
- add_to_cart_rate
33+
- purchase_rate
34+
- average_click_position
35+
- revenue
36+
example: ["search_count", "click_through_rate", "conversion_rate"]
1137
responses:
1238
'200':
1339
description: OK
@@ -30,3 +56,5 @@ get:
3056
$ref: '../../common/responses/MethodNotAllowed.yml'
3157
'404':
3258
$ref: '../../common/responses/IndexNotFound.yml'
59+
'422':
60+
$ref: '../../common/responses/UnprocessableEntity.yml'

0 commit comments

Comments
 (0)