Create a new report

curl -X POST 'https://api.growthbook.io/api/v1/reports' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/reports"

payload = {
    "experimentId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "goalMetrics": ["<string>"],
    "secondaryMetrics": ["<string>"],
    "guardrailMetrics": ["<string>"],
    "activationMetric": "<string>",
    "dimension": "<string>",
    "dateStarted": "2023-11-07T05:31:56Z",
    "dateEnded": "2023-11-07T05:31:56Z",
    "regressionAdjustmentEnabled": True,
    "sequentialTestingEnabled": True,
    "sequentialTestingTuningParameter": 123,
    "lookbackOverride": {
        "type": "date",
        "value": "<unknown>"
    },
    "metricOverrides": [
        {
            "id": "<string>",
            "windowHours": 123,
            "delayHours": 123,
            "winRisk": 123,
            "loseRisk": 123,
            "properPriorOverride": True,
            "properPriorEnabled": True,
            "properPriorMean": 123,
            "properPriorStdDev": 123,
            "regressionAdjustmentOverride": True,
            "regressionAdjustmentEnabled": True,
            "regressionAdjustmentDays": 123
        }
    ],
    "customMetricSlices": [{ "slices": [
                {
                    "column": "<string>",
                    "levels": ["<string>"]
                }
            ] }],
    "segment": "<string>",
    "queryFilter": "<string>",
    "skipPartialData": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    experimentId: '<string>',
    title: '<string>',
    description: '<string>',
    goalMetrics: ['<string>'],
    secondaryMetrics: ['<string>'],
    guardrailMetrics: ['<string>'],
    activationMetric: '<string>',
    dimension: '<string>',
    dateStarted: '2023-11-07T05:31:56Z',
    dateEnded: '2023-11-07T05:31:56Z',
    regressionAdjustmentEnabled: true,
    sequentialTestingEnabled: true,
    sequentialTestingTuningParameter: 123,
    lookbackOverride: {type: 'date', value: '<unknown>'},
    metricOverrides: [
      {
        id: '<string>',
        windowHours: 123,
        delayHours: 123,
        winRisk: 123,
        loseRisk: 123,
        properPriorOverride: true,
        properPriorEnabled: true,
        properPriorMean: 123,
        properPriorStdDev: 123,
        regressionAdjustmentOverride: true,
        regressionAdjustmentEnabled: true,
        regressionAdjustmentDays: 123
      }
    ],
    customMetricSlices: [{slices: [{column: '<string>', levels: ['<string>']}]}],
    segment: '<string>',
    queryFilter: '<string>',
    skipPartialData: true
  })
};

fetch('https://api.growthbook.io/api/v1/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'experimentId' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'goalMetrics' => [
        '<string>'
    ],
    'secondaryMetrics' => [
        '<string>'
    ],
    'guardrailMetrics' => [
        '<string>'
    ],
    'activationMetric' => '<string>',
    'dimension' => '<string>',
    'dateStarted' => '2023-11-07T05:31:56Z',
    'dateEnded' => '2023-11-07T05:31:56Z',
    'regressionAdjustmentEnabled' => true,
    'sequentialTestingEnabled' => true,
    'sequentialTestingTuningParameter' => 123,
    'lookbackOverride' => [
        'type' => 'date',
        'value' => '<unknown>'
    ],
    'metricOverrides' => [
        [
                'id' => '<string>',
                'windowHours' => 123,
                'delayHours' => 123,
                'winRisk' => 123,
                'loseRisk' => 123,
                'properPriorOverride' => true,
                'properPriorEnabled' => true,
                'properPriorMean' => 123,
                'properPriorStdDev' => 123,
                'regressionAdjustmentOverride' => true,
                'regressionAdjustmentEnabled' => true,
                'regressionAdjustmentDays' => 123
        ]
    ],
    'customMetricSlices' => [
        [
                'slices' => [
                                [
                                                                'column' => '<string>',
                                                                'levels' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'segment' => '<string>',
    'queryFilter' => '<string>',
    'skipPartialData' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/reports"

	payload := strings.NewReader("{\n  \"experimentId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goalMetrics\": [\n    \"<string>\"\n  ],\n  \"secondaryMetrics\": [\n    \"<string>\"\n  ],\n  \"guardrailMetrics\": [\n    \"<string>\"\n  ],\n  \"activationMetric\": \"<string>\",\n  \"dimension\": \"<string>\",\n  \"dateStarted\": \"2023-11-07T05:31:56Z\",\n  \"dateEnded\": \"2023-11-07T05:31:56Z\",\n  \"regressionAdjustmentEnabled\": true,\n  \"sequentialTestingEnabled\": true,\n  \"sequentialTestingTuningParameter\": 123,\n  \"lookbackOverride\": {\n    \"type\": \"date\",\n    \"value\": \"<unknown>\"\n  },\n  \"metricOverrides\": [\n    {\n      \"id\": \"<string>\",\n      \"windowHours\": 123,\n      \"delayHours\": 123,\n      \"winRisk\": 123,\n      \"loseRisk\": 123,\n      \"properPriorOverride\": true,\n      \"properPriorEnabled\": true,\n      \"properPriorMean\": 123,\n      \"properPriorStdDev\": 123,\n      \"regressionAdjustmentOverride\": true,\n      \"regressionAdjustmentEnabled\": true,\n      \"regressionAdjustmentDays\": 123\n    }\n  ],\n  \"customMetricSlices\": [\n    {\n      \"slices\": [\n        {\n          \"column\": \"<string>\",\n          \"levels\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"segment\": \"<string>\",\n  \"queryFilter\": \"<string>\",\n  \"skipPartialData\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/reports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"experimentId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goalMetrics\": [\n    \"<string>\"\n  ],\n  \"secondaryMetrics\": [\n    \"<string>\"\n  ],\n  \"guardrailMetrics\": [\n    \"<string>\"\n  ],\n  \"activationMetric\": \"<string>\",\n  \"dimension\": \"<string>\",\n  \"dateStarted\": \"2023-11-07T05:31:56Z\",\n  \"dateEnded\": \"2023-11-07T05:31:56Z\",\n  \"regressionAdjustmentEnabled\": true,\n  \"sequentialTestingEnabled\": true,\n  \"sequentialTestingTuningParameter\": 123,\n  \"lookbackOverride\": {\n    \"type\": \"date\",\n    \"value\": \"<unknown>\"\n  },\n  \"metricOverrides\": [\n    {\n      \"id\": \"<string>\",\n      \"windowHours\": 123,\n      \"delayHours\": 123,\n      \"winRisk\": 123,\n      \"loseRisk\": 123,\n      \"properPriorOverride\": true,\n      \"properPriorEnabled\": true,\n      \"properPriorMean\": 123,\n      \"properPriorStdDev\": 123,\n      \"regressionAdjustmentOverride\": true,\n      \"regressionAdjustmentEnabled\": true,\n      \"regressionAdjustmentDays\": 123\n    }\n  ],\n  \"customMetricSlices\": [\n    {\n      \"slices\": [\n        {\n          \"column\": \"<string>\",\n          \"levels\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"segment\": \"<string>\",\n  \"queryFilter\": \"<string>\",\n  \"skipPartialData\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/reports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"experimentId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goalMetrics\": [\n    \"<string>\"\n  ],\n  \"secondaryMetrics\": [\n    \"<string>\"\n  ],\n  \"guardrailMetrics\": [\n    \"<string>\"\n  ],\n  \"activationMetric\": \"<string>\",\n  \"dimension\": \"<string>\",\n  \"dateStarted\": \"2023-11-07T05:31:56Z\",\n  \"dateEnded\": \"2023-11-07T05:31:56Z\",\n  \"regressionAdjustmentEnabled\": true,\n  \"sequentialTestingEnabled\": true,\n  \"sequentialTestingTuningParameter\": 123,\n  \"lookbackOverride\": {\n    \"type\": \"date\",\n    \"value\": \"<unknown>\"\n  },\n  \"metricOverrides\": [\n    {\n      \"id\": \"<string>\",\n      \"windowHours\": 123,\n      \"delayHours\": 123,\n      \"winRisk\": 123,\n      \"loseRisk\": 123,\n      \"properPriorOverride\": true,\n      \"properPriorEnabled\": true,\n      \"properPriorMean\": 123,\n      \"properPriorStdDev\": 123,\n      \"regressionAdjustmentOverride\": true,\n      \"regressionAdjustmentEnabled\": true,\n      \"regressionAdjustmentDays\": 123\n    }\n  ],\n  \"customMetricSlices\": [\n    {\n      \"slices\": [\n        {\n          \"column\": \"<string>\",\n          \"levels\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"segment\": \"<string>\",\n  \"queryFilter\": \"<string>\",\n  \"skipPartialData\": true\n}"

response = http.request(request)
puts response.read_body

{
  "report": {
    "id": "<string>",
    "dateCreated": "<string>",
    "dateUpdated": "<string>",
    "title": "<string>",
    "description": "<string>",
    "shareUrl": "<string>",
    "experimentId": "<string>",
    "snapshotId": "<string>",
    "snapshotError": "<string>",
    "analysisSettings": {
      "goalMetrics": [
        "<string>"
      ],
      "secondaryMetrics": [
        "<string>"
      ],
      "guardrailMetrics": [
        "<string>"
      ],
      "activationMetric": "<string>",
      "metricOverrides": [
        {
          "id": "<string>",
          "windowHours": 123,
          "delayHours": 123,
          "winRisk": 123,
          "loseRisk": 123,
          "properPriorOverride": true,
          "properPriorEnabled": true,
          "properPriorMean": 123,
          "properPriorStdDev": 123,
          "regressionAdjustmentOverride": true,
          "regressionAdjustmentEnabled": true,
          "regressionAdjustmentDays": 123
        }
      ],
      "customMetricSlices": [
        {
          "slices": [
            {
              "column": "<string>",
              "levels": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "dimension": "<string>",
      "dateStarted": "2023-11-07T05:31:56Z",
      "dateEnded": "2023-11-07T05:31:56Z",
      "regressionAdjustmentEnabled": true,
      "sequentialTestingEnabled": true,
      "sequentialTestingTuningParameter": 123,
      "lookbackOverride": {
        "type": "date",
        "value": "<unknown>"
      },
      "trackingKey": "<string>",
      "exposureQueryId": "<string>",
      "segment": "<string>",
      "queryFilter": "<string>",
      "skipPartialData": true
    },
    "experimentMetadata": {
      "variations": [
        {
          "id": "<string>",
          "name": "<string>",
          "key": "<string>",
          "weight": 123
        }
      ],
      "phases": [
        {
          "name": "<string>",
          "dateStarted": "<string>",
          "dateEnded": "<string>",
          "coverage": 123
        }
      ]
    },
    "results": {
      "id": "<string>",
      "dateUpdated": "<string>",
      "experimentId": "<string>",
      "phase": "<string>",
      "dateStart": "<string>",
      "dateEnd": "<string>",
      "dimension": {
        "type": "<string>",
        "id": "<string>"
      },
      "settings": {
        "datasourceId": "<string>",
        "assignmentQueryId": "<string>",
        "experimentId": "<string>",
        "segmentId": "<string>",
        "queryFilter": "<string>",
        "goals": [
          {
            "metricId": "<string>",
            "overrides": {
              "delayHours": 123,
              "windowHours": 123,
              "winRiskThreshold": 123,
              "loseRiskThreshold": 123,
              "properPriorOverride": true,
              "properPriorEnabled": true,
              "properPriorMean": 123,
              "properPriorStdDev": 123,
              "regressionAdjustmentOverride": true,
              "regressionAdjustmentEnabled": true,
              "regressionAdjustmentDays": 123
            }
          }
        ],
        "secondaryMetrics": [
          {
            "metricId": "<string>",
            "overrides": {
              "delayHours": 123,
              "windowHours": 123,
              "winRiskThreshold": 123,
              "loseRiskThreshold": 123,
              "properPriorOverride": true,
              "properPriorEnabled": true,
              "properPriorMean": 123,
              "properPriorStdDev": 123,
              "regressionAdjustmentOverride": true,
              "regressionAdjustmentEnabled": true,
              "regressionAdjustmentDays": 123
            }
          }
        ],
        "guardrails": [
          {
            "metricId": "<string>",
            "overrides": {
              "delayHours": 123,
              "windowHours": 123,
              "winRiskThreshold": 123,
              "loseRiskThreshold": 123,
              "properPriorOverride": true,
              "properPriorEnabled": true,
              "properPriorMean": 123,
              "properPriorStdDev": 123,
              "regressionAdjustmentOverride": true,
              "regressionAdjustmentEnabled": true,
              "regressionAdjustmentDays": 123
            }
          }
        ],
        "lookbackOverride": {
          "value": 123
        },
        "regressionAdjustmentEnabled": true,
        "sequentialTestingEnabled": true,
        "sequentialTestingTuningParameter": 123,
        "postStratificationEnabled": true,
        "decisionFrameworkSettings": {
          "decisionCriteriaId": "<string>",
          "decisionFrameworkMetricOverrides": [
            {
              "id": "<string>",
              "targetMDE": 123
            }
          ]
        },
        "metricOverrides": [
          {
            "id": "<string>",
            "windowHours": 123,
            "delayHours": 123,
            "properPriorOverride": true,
            "properPriorEnabled": true,
            "properPriorMean": 123,
            "properPriorStdDev": 123,
            "regressionAdjustmentOverride": true,
            "regressionAdjustmentEnabled": true,
            "regressionAdjustmentDays": 123
          }
        ],
        "activationMetric": {
          "metricId": "<string>",
          "overrides": {
            "delayHours": 123,
            "windowHours": 123,
            "winRiskThreshold": 123,
            "loseRiskThreshold": 123,
            "properPriorOverride": true,
            "properPriorEnabled": true,
            "properPriorMean": 123,
            "properPriorStdDev": 123,
            "regressionAdjustmentOverride": true,
            "regressionAdjustmentEnabled": true,
            "regressionAdjustmentDays": 123
          }
        }
      },
      "queryIds": [
        "<string>"
      ],
      "results": [
        {
          "dimension": "<string>",
          "totalUsers": 123,
          "checks": {
            "srm": 123
          },
          "metrics": [
            {
              "metricId": "<string>",
              "variations": [
                {
                  "variationId": "<string>",
                  "analyses": [
                    {
                      "numerator": 123,
                      "denominator": 123,
                      "mean": 123,
                      "stddev": 123,
                      "percentChange": 123,
                      "ciLow": 123,
                      "ciHigh": 123,
                      "pValue": 123,
                      "risk": 123,
                      "chanceToBeatControl": 123
                    }
                  ],
                  "variationName": "<string>",
                  "users": 123
                }
              ],
              "metricName": "<string>"
            }
          ]
        }
      ]
    }
  }
}