Retrieve Pulse Results (Beta)

GET /console/v1/gates/{id}/rules/{ruleID}/pulse_results

Retrieve Pulse Results (Beta)

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/gates/{id}/rules/{ruleID}/pulse_results \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Experiments listed successfully.",
  "data": {
    "id": "a_experiment",
    "description": "",
    "lastModifiedTime": 1707427635442,
    "lastModifierEmail": null,
    "createdTime": 1707427634717,
    "creatorName": "CONSOLE API",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "4FKF0sUbi1D7xZFW5vcHWB",
    "idType": "userID",
    "status": "setup",
    "launchedGroupID": null,
    "layerID": "statsig::a_experiment_layer",
    "hypothesis": "",
    "primaryMetrics": [],
    "primaryMetricTags": [],
    "secondaryMetrics": [],
    "secondaryMetricTags": [],
    "startTime": null,
    "endTime": null,
    "decisionTime": null,
    "groups": [
      {
        "name": "Control",
        "id": "4HbgLdfqlIeN3sHkyMG1qC",
        "size": 50,
        "parameterValues": {}
      },
      {
        "name": "Test",
        "size": 50,
        "parameterValues": {}
      }
    ],
    "allocation": 100,
    "duration": 14,
    "targetingGateID": "",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "tags": [
      "* Core"
    ],
    "decisionReason": "",
    "owner": {
      "ownerType": "USER",
      "ownerName": "Test User"
    },
    "healthCheckStatus": "PASSED",
    "inlineTargetingRulesJSON": "{}"
  }
}

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.

Show child attributes