Skip to main content
GET
/
console
/
v1
/
experiments
/
{id}
/
pulse_metric_result
Retrieve Pulse Metric Result
curl --request GET \
  --url https://statsigapi.net/console/v1/experiments/{id}/pulse_metric_result \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "<string>",
  "data": {
    "ds": "<string>",
    "dimensionResults": [
      {
        "dimension": "<string>",
        "dimension_value": "<string>",
        "metric": {
          "metricID": "<string>",
          "metricName": "<string>",
          "directionality": "increase",
          "absoluteChange": 123,
          "confidenceIntervalDelta": 123,
          "confidenceInterval": {
            "lower": -1.33,
            "upper": 1.33
          },
          "percentChange": 123,
          "sequentialTestingConfidenceIntervalDelta": 123,
          "sequentialTestingConfidenceInterval": {
            "lower": -1.33,
            "upper": 1.33
          },
          "percentConfidenceIntervalDelta": 123,
          "percentConfidenceInterval": {
            "lower": -1.33,
            "upper": 1.33
          },
          "percentSequentialTestingConfidenceIntervalDelta": 123,
          "percentSequentialTestingConfidenceInterval": {
            "lower": -1.33,
            "upper": 1.33
          },
          "testMean": 123,
          "controlMean": 123,
          "testStd": 123,
          "controlStd": 123,
          "testUnits": 123,
          "controlUnits": 123,
          "pValue": 123,
          "reversePower": 123,
          "absoluteToplineImpact": 123,
          "absoluteToplineImpactDelta": 123,
          "relativeToplineImpact": 123,
          "relativeToplineImpactDelta": 123,
          "projectedAbsoluteToplineImpact": 123,
          "projectedAbsoluteToplineImpactDelta": 123,
          "projectedRelativeToplineImpact": 123,
          "projectedRelativeToplineImpactDelta": 123
        }
      }
    ]
  }
}

Authorizations

STATSIG-API-KEY
string
header
required

Path Parameters

id
string
required

id

Query Parameters

control
string
required

Control Group ID

test
string
required

Test Group ID

cuped
string

Whether to apply CUPED. Allowed values are "true" or "false".

confidence
string

Confidence interval (0-100)

applyBonferroniPerVariant
string

Whether to apply Bonferroni Per Variant. Allowed values are "true" or "false".

applyBonferroniPerMetric
string

Whether to apply Bonferroni Per Metric. Allowed values are "true" or "false".

bonferroniPrimaryMetricWeight
string

α allocated to primary metrics

applyBenjaminiHochbergPerMetric
string

Whether to apply Benjamini-Hochberg Correction Per Metric. Allowed values are "true" or "false".

applyBenjaminiHochbergPerVariant
string

Whether to apply Benjamini-Hochberg Correction Per Variant. Allowed values are "true" or "false".

date
string

Date for pulse results. format must be YYYY-MM-DD

metricID
string
required

Metric ID in format <metric_name>::<metric_type>

Response

200 - application/json

Get Pulse Metric Result Success

message
string
required

A simple string explaining the result of the operation.

data
object
required

A single result.