Create a single experimentTemplate

POST /experiment-templates

cURL

cURL

curl -X POST https://api.growthbook.io/api/v1/experiment-templates -d '{ ... }' -u secret_abc123DEF456

200

{
  "experimentTemplate": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "owner": "<string>",
    "templateMetadata": {
      "name": "<string>",
      "description": "<string>"
    },
    "type": "standard",
    "datasource": "<string>",
    "exposureQueryId": "<string>",
    "statsEngine": "bayesian",
    "targeting": {
      "coverage": 123,
      "condition": "<string>",
      "savedGroups": [
        {
          "match": "all",
          "ids": [
            "<string>"
          ]
        }
      ],
      "prerequisites": [
        {
          "id": "<string>",
          "condition": "<string>"
        }
      ]
    },
    "project": "<string>",
    "hypothesis": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "customFields": {},
    "hashAttribute": "<string>",
    "fallbackAttribute": "<string>",
    "disableStickyBucketing": true,
    "goalMetrics": [
      "<string>"
    ],
    "secondaryMetrics": [
      "<string>"
    ],
    "guardrailMetrics": [
      "<string>"
    ],
    "activationMetric": "<string>",
    "segment": "<string>",
    "skipPartialData": true,
    "customMetricSlices": [
      {
        "slices": [
          {
            "column": "<string>",
            "levels": [
              "<string>"
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Body

application/json

templateMetadata · object · required

Show child attributes

type · enum<string> · required

Available options: standard

datasource · string · required

exposureQueryId · string · required

statsEngine · enum<string> · required

Available options: bayesian, frequentist

targeting · object · required

Show child attributes

project · string

hypothesis · string

description · string

tags · string[]

customFields · object

Show child attributes

hashAttribute · string

fallbackAttribute · string

disableStickyBucketing · boolean

goalMetrics · string[]

secondaryMetrics · string[]

guardrailMetrics · string[]

activationMetric · string

segment · string

skipPartialData · boolean

customMetricSlices · object[]

Show child attributes

Response

200 - application/json

Success

experimentTemplate · object · required

Show child attributes