f687d224b37d
Retrieve Pulse Metric Result
Path parameters
id
Query parameters
Control Group ID
Test Group ID
Whether to apply CUPED. Allowed values are "true" or "false".
Confidence interval (0-100)
Whether to apply Bonferroni Per Variant. Allowed values are "true" or "false".
Whether to apply Bonferroni Per Metric. Allowed values are "true" or "false".
α allocated to primary metrics
Whether to apply Benjamini-Hochberg Correction Per Metric. Allowed values are "true" or "false".
Whether to apply Benjamini-Hochberg Correction Per Variant. Allowed values are "true" or "false".
Whether Benjamini-Hochberg correction should apply only to primary metrics. Allowed values are "true" or "false".
Date for pulse results. format must be YYYY-MM-DD
Whether to compute the Benjamini-Hochberg / Bonferroni-per-group correction across all of the experiment's test groups (matching the Console Results tab default for multi-group experiments) rather than only the requested test-vs-control pair. The returned results are always scoped to the requested pair; this controls only the correction family. Allowed values are "true" or "false". Defaults to "true".
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
}
}
}
]
}
}