Experiment Settings API

Configure account-level experimentation — pixel token, sticky cookie name, and the domain allowlist that the experiments runtime is allowed to fire on.

Account-level experimentation bootstrap configuration. The settings record holds the pixel token used by the experiments runtime, the cookie name used for sticky variant assignment, and the domain allowlist. Most accounts only ever have one settings record — use its id as experimentSettingsId when creating an experiment.

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiment-settings"

{
  "entities": [
    {
      "id": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",
      "accountId": "org_01HZX8Y0YV9M7Y0F5Q1V3W4P6R",
      "name": "Default Web Experiment Settings",
      "pixel": "string",
      "cookieName": "string",
      "whitelistDomains": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "createdByUserId": "string",
      "updatedByUserId": "string"
    }
  ]
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Human-readable name for this experimentation configuration. Defaults to Experiment Settings when omitted on create.

cookieName?|

Cookie name used to persist sticky variant assignments in the browser. Defaults to _cord_exp when omitted on create.

whitelistDomains?array<string>|

Limits which domains can load your experiments. When set, experiments using this settings record are only served on these domains; the SDK refuses to load anywhere else and your experiments never run on those hosts. Separate from source whitelistDomains, which limits which domains can send events to the CDP.

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/experiment-settings" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",
  "accountId": "org_01HZX8Y0YV9M7Y0F5Q1V3W4P6R",
  "name": "Default Web Experiment Settings",
  "pixel": "string",
  "cookieName": "string",
  "whitelistDomains": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiment-settings/string"

{
  "id": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",
  "accountId": "org_01HZX8Y0YV9M7Y0F5Q1V3W4P6R",
  "name": "Default Web Experiment Settings",
  "pixel": "string",
  "cookieName": "string",
  "whitelistDomains": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Human-readable name for this experimentation configuration. Defaults to Experiment Settings when omitted on create.

cookieName?|

Cookie name used to persist sticky variant assignments in the browser. Defaults to _cord_exp when omitted on create.

whitelistDomains?array<string>|

Response Body

`application/json`

curl -X PATCH "https://example.com/rest/v1/experiment-settings/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",
  "accountId": "org_01HZX8Y0YV9M7Y0F5Q1V3W4P6R",
  "name": "Default Web Experiment Settings",
  "pixel": "string",
  "cookieName": "string",
  "whitelistDomains": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/rest/v1/experiment-settings/string"

{
  "id": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",
  "accountId": "org_01HZX8Y0YV9M7Y0F5Q1V3W4P6R",
  "name": "Default Web Experiment Settings",
  "pixel": "string",
  "cookieName": "string",
  "whitelistDomains": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Experiment Settings

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`