Retrieve Pulse Results

gethttps://statsigapi.net/console/v1/gates/{id}/rules/{ruleID}/pulse_results

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Gate ID

ruleIDstringrequired

Rule ID

Query parameters

cupedstring

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

confidencestring

Confidence interval (0-100)

Response

application/json

200Get Pulse Results Success

messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Show child attributes

dsstringrequired

monitoringMetricsobject[]required

Show child attributes

metricID[]stringrequired

metricName[]stringrequired

directionality[]stringrequired

Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.

absoluteChange[]number

confidenceIntervalDelta[]number

Absolute confidence interval delta

confidenceInterval[]object

Confidence interval bounds

Show child attributes

lowernumberrequired

uppernumberrequired

percentChange[]number

sequentialTestingConfidenceIntervalDelta[]number

sequentialTestingConfidenceInterval[]object

Confidence interval bounds

Show child attributes

lowernumberrequired

uppernumberrequired

percentConfidenceIntervalDelta[]number

percentConfidenceInterval[]object

Confidence interval bounds

Show child attributes

lowernumberrequired

uppernumberrequired

percentSequentialTestingConfidenceIntervalDelta[]number

percentSequentialTestingConfidenceInterval[]object

Confidence interval bounds

Show child attributes

lowernumberrequired

uppernumberrequired

testMean[]number

controlMean[]number

testStd[]number

controlStd[]number

testUnits[]number

controlUnits[]number

pValue[]number

sequentialTestingPValue[]number

adjustedAlpha[]number

reversePower[]number

absoluteToplineImpact[]number

absoluteToplineImpactDelta[]number

relativeToplineImpact[]number

relativeToplineImpactDelta[]number

projectedAbsoluteToplineImpact[]number

projectedAbsoluteToplineImpactDelta[]number

projectedRelativeToplineImpact[]number

projectedRelativeToplineImpactDelta[]number

Retrieve Pulse Results

curl -X GET "https://statsigapi.net/console/v1/gates/{id}/rules/{ruleID}/pulse_results" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

200

Response

{
  "message": "Successfully loaded Pulse Results",
  "data": {
    "ds": "2024-09-12",
    "monitoringMetrics": [
      {
        "metricID": "conversion_rate",
        "metricName": "Conversion Rate",
        "directionality": "increase",
        "absoluteChange": 0.0084,
        "confidenceIntervalDelta": 0.0039,
        "confidenceInterval": {
          "lower": 0.0045,
          "upper": 0.0123
        },
        "percentChange": 628,
        "sequentialTestingConfidenceIntervalDelta": 0.0075,
        "sequentialTestingConfidenceInterval": {
          "lower": 0.0009,
          "upper": 0.0159
        },
        "percentConfidenceIntervalDelta": 293.4,
        "percentConfidenceInterval": {
          "lower": 334.6,
          "upper": 921.4
        },
        "percentSequentialTestingConfidenceIntervalDelta": 563.9,
        "percentSequentialTestingConfidenceInterval": {
          "lower": 64.1,
          "upper": 1191.9
        },
        "testMean": 0.0097,
        "controlMean": 0.0013,
        "testStd": 0.0015,
        "controlStd": 0.0003,
        "testUnits": 7912,
        "controlUnits": 71069,
        "pValue": 0.0001,
        "sequentialTestingPValue": 0.0041,
        "adjustedAlpha": 0.01,
        "reversePower": 225.3
      },
      {
        "metricID": "user_engagement",
        "metricName": "User Engagement Score",
        "directionality": "increase",
        "absoluteChange": 0.15,
        "confidenceIntervalDelta": 0.08,
        "confidenceInterval": {
          "lower": 0.07,
          "upper": 0.23
        },
        "percentChange": 3.2,
        "sequentialTestingConfidenceIntervalDelta": 0.09,
        "sequentialTestingConfidenceInterval": {
          "lower": 0.05,
          "upper": 0.24
        },
        "percentConfidenceIntervalDelta": 1.7,
        "percentConfidenceInterval": {
          "lower": 1.5,
          "upper": 4.9
        },
        "percentSequentialTestingConfidenceIntervalDelta": 2.1,
        "percentSequentialTestingConfidenceInterval": {
          "lower": 1.1,
          "upper": 5.3
        },
        "testMean": 4.85,
        "controlMean": 4.7,
        "testStd": 0.35,
        "controlStd": 0.32,
        "testUnits": 2200,
        "controlUnits": 2150,
        "pValue": 0.025,
        "sequentialTestingPValue": 0.022,
        "adjustedAlpha": 0.05,
        "reversePower": 0.64
      }
    ]
  }
}

Was this helpful?