v2
latestOpenAPI 3.0.02026-08-073221853.1 MBExperiments
Experiments
Retrieve Pulse Metric Result
get/console/v1/experiments/{id}/pulse_metric_result
Path parameters
idstring required
id
Query parameters
controlstring required
Control Group ID
teststring required
Test Group ID
cupedstring
Whether to apply CUPED. Allowed values are "true" or "false".
confidencestring
Confidence interval (0-100)
applyBonferroniPerVariantstring
Whether to apply Bonferroni Per Variant. Allowed values are "true" or "false".
applyBonferroniPerMetricstring
Whether to apply Bonferroni Per Metric. Allowed values are "true" or "false".
bonferroniPrimaryMetricWeightstring
α allocated to primary metrics
applyBenjaminiHochbergPerMetricstring
Whether to apply Benjamini-Hochberg Correction Per Metric. Allowed values are "true" or "false".
applyBenjaminiHochbergPerVariantstring
Whether to apply Benjamini-Hochberg Correction Per Variant. Allowed values are "true" or "false".
benjaminiPrimaryMetricsOnlystring
Whether Benjamini-Hochberg correction should apply only to primary metrics. Allowed values are "true" or "false".
datestring
Date for pulse results. format must be YYYY-MM-DD
metricIDstring required
Metric ID in format <metric_name>::<metric_type>
Response
Get Pulse Metric Result Success
Example response
{
"data": {
"dimensionResults": [
{
"metric": {
"directionality": "increase",
"confidenceInterval": {
"lower": -1.33,
"upper": 1.33
},
"sequentialTestingConfidenceInterval": {
"lower": -1.33,
"upper": 1.33
},
"percentConfidenceInterval": {
"lower": -1.33,
"upper": 1.33
},
"percentSequentialTestingConfidenceInterval": {
"lower": -1.33,
"upper": 1.33
}
}
}
]
}
}