---
title: Retrieve Pulse Results (Beta)
description: Retrieve Pulse Results (Beta)
product: general
token_estimate: 4717
---
# Retrieve Pulse Results (Beta)

> For AI agents: a documentation index is available at [/llms.txt](/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## Retrieve Pulse Results (Beta)

**GET** `/console/v1/experiments/{id}/pulse_results`

Full URL: `https://statsigapi.net/console/v1/experiments/{id}/pulse_results`

Retrieve Pulse Results (Beta)

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| STATSIG-API-KEY | string | Yes | — | apiKey (header) |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| id (path) | string | Yes | — | id |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| control (query) | string | Yes | — | Control Group ID |
| test (query) | string | Yes | — | Test Group ID |
| cuped (query) | string | No | — | Whether to apply CUPED. Allowed values are "true" or "false". |
| confidence (query) | string | No | — | Confidence interval (0-100) |
| applyBonferroniPerVariant (query) | string | No | — | Whether to apply Bonferroni Per Variant. Allowed values are "true" or "false". |
| applyBonferroniPerMetric (query) | string | No | — | Whether to apply Bonferroni Per Metric. Allowed values are "true" or "false". |
| bonferroniPrimaryMetricWeight (query) | string | No | — | α allocated to primary metrics |
| applyBenjaminiHochbergPerMetric (query) | string | No | — | Whether to apply Benjamini-Hochberg Correction Per Metric. Allowed values are "true" or "false". |
| applyBenjaminiHochbergPerVariant (query) | string | No | — | Whether to apply Benjamini-Hochberg Correction Per Variant. Allowed values are "true" or "false". |
| benjaminiPrimaryMetricsOnly (query) | string | No | — | Whether Benjamini-Hochberg correction should apply only to primary metrics. Allowed values are "true" or "false". |
| date (query) | string | No | — | Date for pulse results. format must be YYYY-MM-DD |
| benjaminiAcrossAllTestGroups (query) | string | No | — | 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". |

## Response (application/json)

**200** — Get Pulse Results Success

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object | Yes | — | — |
| data.ds | string | Yes | — | — |
| data.primaryMetrics | object[] | Yes | — | — |
| data.primaryMetrics.metricID | string | Yes | — | — |
| data.primaryMetrics.metricName | string | Yes | — | — |
| data.primaryMetrics.directionality | string | Yes | increase | Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes. Allowed values: increase, decrease |
| data.primaryMetrics.error | oneOf | No | no_data | Machine-readable reason when pulse statistics are unavailable. Common values include no_data (insufficient data), echidna_unripe (not yet loaded), and setup_incomplete (misconfigured metric source). Additional string values may appear for cohort/bake windows or other load failures. Constraints: nullable, string, string |
| data.primaryMetrics.warnings | string[] | No | — | Human-readable warnings about metric data quality, load state, or partial pipeline failures. |
| data.primaryMetrics.absoluteChange | number | No | — | — |
| data.primaryMetrics.confidenceIntervalDelta | number | No | — | Absolute confidence interval delta |
| data.primaryMetrics.confidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.primaryMetrics.confidenceInterval.lower | number | Yes | — | — |
| data.primaryMetrics.confidenceInterval.upper | number | Yes | — | — |
| data.primaryMetrics.percentChange | number | No | — | — |
| data.primaryMetrics.sequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.primaryMetrics.sequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.primaryMetrics.sequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.primaryMetrics.sequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.primaryMetrics.percentConfidenceIntervalDelta | number | No | — | — |
| data.primaryMetrics.percentConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.primaryMetrics.percentConfidenceInterval.lower | number | Yes | — | — |
| data.primaryMetrics.percentConfidenceInterval.upper | number | Yes | — | — |
| data.primaryMetrics.percentSequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.primaryMetrics.percentSequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.primaryMetrics.percentSequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.primaryMetrics.percentSequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.primaryMetrics.testMean | number | No | — | — |
| data.primaryMetrics.controlMean | number | No | — | — |
| data.primaryMetrics.testStd | number | No | — | — |
| data.primaryMetrics.controlStd | number | No | — | — |
| data.primaryMetrics.testUnits | number | No | — | — |
| data.primaryMetrics.controlUnits | number | No | — | — |
| data.primaryMetrics.pValue | number | No | — | — |
| data.primaryMetrics.sequentialTestingPValue | number | No | — | Constraints: nullable |
| data.primaryMetrics.adjustedAlpha | number | No | — | — |
| data.primaryMetrics.reversePower | number | No | — | — |
| data.primaryMetrics.absoluteToplineImpact | number | No | — | — |
| data.primaryMetrics.absoluteToplineImpactDelta | number | No | — | — |
| data.primaryMetrics.relativeToplineImpact | number | No | — | — |
| data.primaryMetrics.relativeToplineImpactDelta | number | No | — | — |
| data.primaryMetrics.projectedAbsoluteToplineImpact | number | No | — | — |
| data.primaryMetrics.projectedAbsoluteToplineImpactDelta | number | No | — | — |
| data.primaryMetrics.projectedRelativeToplineImpact | number | No | — | — |
| data.primaryMetrics.projectedRelativeToplineImpactDelta | number | No | — | — |
| data.secondaryMetrics | object[] | Yes | — | — |
| data.secondaryMetrics.metricID | string | Yes | — | — |
| data.secondaryMetrics.metricName | string | Yes | — | — |
| data.secondaryMetrics.directionality | string | Yes | increase | Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes. Allowed values: increase, decrease |
| data.secondaryMetrics.error | oneOf | No | no_data | Machine-readable reason when pulse statistics are unavailable. Common values include no_data (insufficient data), echidna_unripe (not yet loaded), and setup_incomplete (misconfigured metric source). Additional string values may appear for cohort/bake windows or other load failures. Constraints: nullable, string, string |
| data.secondaryMetrics.warnings | string[] | No | — | Human-readable warnings about metric data quality, load state, or partial pipeline failures. |
| data.secondaryMetrics.absoluteChange | number | No | — | — |
| data.secondaryMetrics.confidenceIntervalDelta | number | No | — | Absolute confidence interval delta |
| data.secondaryMetrics.confidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.secondaryMetrics.confidenceInterval.lower | number | Yes | — | — |
| data.secondaryMetrics.confidenceInterval.upper | number | Yes | — | — |
| data.secondaryMetrics.percentChange | number | No | — | — |
| data.secondaryMetrics.sequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.secondaryMetrics.sequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.secondaryMetrics.sequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.secondaryMetrics.sequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.secondaryMetrics.percentConfidenceIntervalDelta | number | No | — | — |
| data.secondaryMetrics.percentConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.secondaryMetrics.percentConfidenceInterval.lower | number | Yes | — | — |
| data.secondaryMetrics.percentConfidenceInterval.upper | number | Yes | — | — |
| data.secondaryMetrics.percentSequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.secondaryMetrics.percentSequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.secondaryMetrics.percentSequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.secondaryMetrics.percentSequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.secondaryMetrics.testMean | number | No | — | — |
| data.secondaryMetrics.controlMean | number | No | — | — |
| data.secondaryMetrics.testStd | number | No | — | — |
| data.secondaryMetrics.controlStd | number | No | — | — |
| data.secondaryMetrics.testUnits | number | No | — | — |
| data.secondaryMetrics.controlUnits | number | No | — | — |
| data.secondaryMetrics.pValue | number | No | — | — |
| data.secondaryMetrics.sequentialTestingPValue | number | No | — | Constraints: nullable |
| data.secondaryMetrics.adjustedAlpha | number | No | — | — |
| data.secondaryMetrics.reversePower | number | No | — | — |
| data.secondaryMetrics.absoluteToplineImpact | number | No | — | — |
| data.secondaryMetrics.absoluteToplineImpactDelta | number | No | — | — |
| data.secondaryMetrics.relativeToplineImpact | number | No | — | — |
| data.secondaryMetrics.relativeToplineImpactDelta | number | No | — | — |
| data.secondaryMetrics.projectedAbsoluteToplineImpact | number | No | — | — |
| data.secondaryMetrics.projectedAbsoluteToplineImpactDelta | number | No | — | — |
| data.secondaryMetrics.projectedRelativeToplineImpact | number | No | — | — |
| data.secondaryMetrics.projectedRelativeToplineImpactDelta | number | No | — | — |
| data.otherMetrics | object[] | No | — | — |
| data.otherMetrics.metricID | string | Yes | — | — |
| data.otherMetrics.metricName | string | Yes | — | — |
| data.otherMetrics.directionality | string | Yes | increase | Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes. Allowed values: increase, decrease |
| data.otherMetrics.error | oneOf | No | no_data | Machine-readable reason when pulse statistics are unavailable. Common values include no_data (insufficient data), echidna_unripe (not yet loaded), and setup_incomplete (misconfigured metric source). Additional string values may appear for cohort/bake windows or other load failures. Constraints: nullable, string, string |
| data.otherMetrics.warnings | string[] | No | — | Human-readable warnings about metric data quality, load state, or partial pipeline failures. |
| data.otherMetrics.absoluteChange | number | No | — | — |
| data.otherMetrics.confidenceIntervalDelta | number | No | — | Absolute confidence interval delta |
| data.otherMetrics.confidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.otherMetrics.confidenceInterval.lower | number | Yes | — | — |
| data.otherMetrics.confidenceInterval.upper | number | Yes | — | — |
| data.otherMetrics.percentChange | number | No | — | — |
| data.otherMetrics.sequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.otherMetrics.sequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.otherMetrics.sequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.otherMetrics.sequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.otherMetrics.percentConfidenceIntervalDelta | number | No | — | — |
| data.otherMetrics.percentConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.otherMetrics.percentConfidenceInterval.lower | number | Yes | — | — |
| data.otherMetrics.percentConfidenceInterval.upper | number | Yes | — | — |
| data.otherMetrics.percentSequentialTestingConfidenceIntervalDelta | number | No | — | — |
| data.otherMetrics.percentSequentialTestingConfidenceInterval | object | No | {"lower":-1.33,"upper":1.33} | Confidence interval bounds |
| data.otherMetrics.percentSequentialTestingConfidenceInterval.lower | number | Yes | — | — |
| data.otherMetrics.percentSequentialTestingConfidenceInterval.upper | number | Yes | — | — |
| data.otherMetrics.testMean | number | No | — | — |
| data.otherMetrics.controlMean | number | No | — | — |
| data.otherMetrics.testStd | number | No | — | — |
| data.otherMetrics.controlStd | number | No | — | — |
| data.otherMetrics.testUnits | number | No | — | — |
| data.otherMetrics.controlUnits | number | No | — | — |
| data.otherMetrics.pValue | number | No | — | — |
| data.otherMetrics.sequentialTestingPValue | number | No | — | Constraints: nullable |
| data.otherMetrics.adjustedAlpha | number | No | — | — |
| data.otherMetrics.reversePower | number | No | — | — |
| data.otherMetrics.absoluteToplineImpact | number | No | — | — |
| data.otherMetrics.absoluteToplineImpactDelta | number | No | — | — |
| data.otherMetrics.relativeToplineImpact | number | No | — | — |
| data.otherMetrics.relativeToplineImpactDelta | number | No | — | — |
| data.otherMetrics.projectedAbsoluteToplineImpact | number | No | — | — |
| data.otherMetrics.projectedAbsoluteToplineImpactDelta | number | No | — | — |
| data.otherMetrics.projectedRelativeToplineImpact | number | No | — | — |
| data.otherMetrics.projectedRelativeToplineImpactDelta | number | No | — | — |

```json
{
  "message": "Successfully loaded Pulse Results",
  "data": {
    "primaryMetrics": [
      {
        "metricID": "Purchase::user_warehouse",
        "value": -0.5656598720428505,
        "confidence_interval_delta": 1.3331521511820725,
        "confidence_interval": {
          "lower": -1.8988120232249,
          "upper": 0.7674922791392
        },
        "percent_change": -0.9104559464139017,
        "percent_confidence_interval_delta": 2.145770565507353,
        "percent_confidence_interval": {
          "lower": -3.0562265119213,
          "upper": 1.2353146190935
        },
        "percent_sequential_testing_confidence_interval_delta": -1.6095466399726037,
        "percent_sequential_testing_confidence_interval": {
          "lower": 0.6990906935587,
          "upper": -2.5200025863865
        },
        "test_mean": 61.56363636363636,
        "control_mean": 62.12929623567921,
        "test_std": 0.7461734327711735,
        "control_std": 0.7248273669644147,
        "test_units": 1669,
        "control_units": 1589,
        "p_value": 0.7066986120589813,
        "sequentialTestingPValue": 0.7066986120589813,
        "adjustedAlpha": 0.05
      }
    ],
    "secondaryMetrics": [
      {
        "metricID": "Support Success Rate::user_warehouse",
        "value": 0.0032568848232868985,
        "confidence_interval_delta": 0.009120368109978388,
        "confidence_interval": {
          "lower": -0.00586348328669149,
          "upper": 0.012377252933265286
        },
        "percent_change": 0.4569873400680713,
        "percent_confidence_interval_delta": 1.2797175795779019,
        "percent_confidence_interval": {
          "lower": -0.8227302395098306,
          "upper": 1.736704919646
        },
        "percent_sequential_testing_confidence_interval_delta": -140.31424654645156,
        "percent_sequential_testing_confidence_interval": {
          "lower": 140.77123388651964,
          "upper": -139.8572592063835
        },
        "test_mean": 0.7159428911362284,
        "control_mean": 0.7126860063129415,
        "test_std": 0.0038882253564431193,
        "control_std": 0.003953024266669566,
        "test_units": 4696,
        "control_units": 4690,
        "p_value": 0.5569502167465609,
        "sequentialTestingPValue": 0.5569502167465609,
        "adjustedAlpha": 0.05
      }
    ]
  }
}
```

## Code samples

### cURL

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

### Python

```python
import requests

response = requests.get(
    "https://statsigapi.net/console/v1/experiments/{id}/pulse_results",
    headers={
        "Content-Type": "application/json",
        "STATSIG-API-KEY": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://statsigapi.net/console/v1/experiments/{id}/pulse_results", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "STATSIG-API-KEY": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://statsigapi.net/console/v1/experiments/{id}/pulse_results");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "STATSIG-API-KEY: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("GET", "https://statsigapi.net/console/v1/experiments/{id}/pulse_results", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("STATSIG-API-KEY", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://statsigapi.net/console/v1/experiments/{id}/pulse_results"))
      .method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("STATSIG-API-KEY", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://statsigapi.net/console/v1/experiments/{id}/pulse_results")
request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["STATSIG-API-KEY"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```