Skip to content

Commit e7642ce

Browse files
authored
feat(specs): add user metrics to abtesting-v3 timeseries enum (#7181)
1 parent d3b6c2b commit e7642ce

4 files changed

Lines changed: 45 additions & 2 deletions

File tree

โ€Žspecs/abtesting-v3/common/schemas/ABTest.ymlโ€Ž

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,19 @@ PrimaryMetric:
135135
When `method` is omitted and the test defaults to `bayesian`, the default primary metric is `conversion_rate`,
136136
or the first metric in `metrics` that supports Bayesian analysis if `metrics` doesn't include conversion rate.
137137
If the request includes a non-empty `metrics` list, this metric must be in that list.
138-
Revenue per search requires access to revenue analytics.
138+
User-level rates (`*_users_rate`) are the share of tracked users with at least one such search.
139+
Add-to-cart rates, purchase rates, and revenue per search require access to revenue analytics.
139140
example: conversion_rate
140141
enum:
141142
- add_to_cart_rate
142143
- click_through_rate
143144
- conversion_rate
144145
- purchase_rate
145146
- revenue_per_search
147+
- add_to_cart_users_rate
148+
- clicked_users_rate
149+
- converted_users_rate
150+
- purchase_users_rate
146151

147152
MetricsFilter:
148153
type: object

โ€Žspecs/abtesting-v3/common/schemas/Timeseries.ymlโ€Ž

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,19 @@ MetricName:
6262
- revenue
6363
- revenue_per_search
6464
- average_order_value
65+
- clicked_users_count
66+
- converted_users_count
67+
- add_to_cart_users_count
68+
- purchase_users_count
69+
- users_with_no_results_count
70+
- clicked_users_rate
71+
- converted_users_rate
72+
- add_to_cart_users_rate
73+
- purchase_users_rate
74+
- avg_click_through_rate_per_user
75+
- avg_conversion_rate_per_user
76+
- avg_purchase_rate_per_user
77+
- avg_add_to_cart_rate_per_user
78+
- avg_click_position_per_user
79+
- winsorized_revenue_per_user
80+
- winsorized_revenue_per_purchaser

โ€Žspecs/abtesting-v3/paths/timeseries.ymlโ€Ž

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ get:
1212
- $ref: '../../common/parameters.yml#/EndDate'
1313
- in: query
1414
name: metric
15-
description: List of metrics to retrieve. If not specified, all metrics are returned.
15+
description: Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
16+
style: form
17+
explode: false
1618
schema:
1719
type: array
1820
items:

โ€Žtests/CTS/requests/abtesting-v3/getTimeseries.jsonโ€Ž

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,25 @@
2727
"methods": "bayesian"
2828
}
2929
}
30+
},
31+
{
32+
"testName": "getTimeseries with user-based metrics",
33+
"parameters": {
34+
"id": 42,
35+
"startDate": "1999-09-19",
36+
"endDate": "2001-01-01",
37+
"metric": ["clicked_users_rate", "converted_users_rate"],
38+
"methods": ["bayesian"]
39+
},
40+
"request": {
41+
"path": "/3/abtests/42/timeseries",
42+
"method": "GET",
43+
"queryParameters": {
44+
"startDate": "1999-09-19",
45+
"endDate": "2001-01-01",
46+
"metric": "clicked_users_rate%2Cconverted_users_rate",
47+
"methods": "bayesian"
48+
}
49+
}
3050
}
3151
]

0 commit comments

Comments
ย (0)