Skip to main content
GET
/
console
/
v1
/
gates
/
{id}
/
rules
/
{ruleID}
/
pulse_results
Retrieve Pulse Results
curl --request GET \
  --url https://statsigapi.net/console/v1/gates/{id}/rules/{ruleID}/pulse_results \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Successfully loaded Pulse Results",
  "data": {
    "ds": "2024-09-12",
    "monitoringMetrics": [
      {
        "metricID": "conversion_rate",
        "metricName": "Conversion Rate",
        "directionality": "increase",
        "absoluteChange": 0.0025,
        "confidenceIntervalDelta": 0.0015,
        "percentChange": 2.5,
        "percentConfidenceIntervalDelta": 1.5,
        "percentSequentialTestingConfidenceIntervalDelta": -0.8,
        "testMean": 0.1025,
        "controlMean": 0.1,
        "testStd": 0.0012,
        "controlStd": 0.0011,
        "testUnits": 1500,
        "controlUnits": 1480,
        "pValue": 0.045
      },
      {
        "metricID": "user_engagement",
        "metricName": "User Engagement Score",
        "directionality": "increase",
        "absoluteChange": 0.15,
        "confidenceIntervalDelta": 0.08,
        "percentChange": 3.2,
        "percentConfidenceIntervalDelta": 1.7,
        "percentSequentialTestingConfidenceIntervalDelta": -2.1,
        "testMean": 4.85,
        "controlMean": 4.7,
        "testStd": 0.35,
        "controlStd": 0.32,
        "testUnits": 2200,
        "controlUnits": 2150,
        "pValue": 0.025
      }
    ]
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Path Parameters

​
id
string
required

Gate ID

​
ruleID
string
required

Rule ID

Query Parameters

​
cuped
string

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

​
confidence
string

Confidence interval (0-100)

Response

200 - application/json

Get Pulse Results Success

​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.