Experiment Settings
Configure account-level experimentation: pixel token, sticky cookie name, and the domain allowlist where experiments can run.
Account-level experimentation settings. The settings record holds the pixel token used by the experiment script, the cookie name used for sticky variant assignment, and the domain allowlist. Most accounts have one settings record, and its id is the experimentSettingsId on each experiment.
GET/rest/v1/experiment-settings
Ours Privacy API key
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/experiment-settings"{ "entities": [ { "id": "string", "accountId": "string", "name": "string", "pixel": "string", "cookieName": "string", "whitelistDomains": [ "string" ], "createdAt": "string", "updatedAt": "string", "createdByUserId": "string", "updatedByUserId": "string" } ]}POST/rest/v1/experiment-settings
Ours Privacy API key
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/experiment-settings" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "accountId": "string", "name": "string", "pixel": "string", "cookieName": "string", "whitelistDomains": [ "string" ], "createdAt": "string", "updatedAt": "string", "createdByUserId": "string", "updatedByUserId": "string"}GET/rest/v1/experiment-settings/{id}
Ours Privacy API key
In: header
Path Parameters
Experiment settings record id, as returned by the list operation.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/experiment-settings/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "string", "accountId": "string", "name": "string", "pixel": "string", "cookieName": "string", "whitelistDomains": [ "string" ], "createdAt": "string", "updatedAt": "string", "createdByUserId": "string", "updatedByUserId": "string"}PATCH/rest/v1/experiment-settings/{id}
Ours Privacy API key
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/rest/v1/experiment-settings/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "accountId": "string", "name": "string", "pixel": "string", "cookieName": "string", "whitelistDomains": [ "string" ], "createdAt": "string", "updatedAt": "string", "createdByUserId": "string", "updatedByUserId": "string"}DELETE/rest/v1/experiment-settings/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/rest/v1/experiment-settings/string"{ "id": "string", "accountId": "string", "name": "string", "pixel": "string", "cookieName": "string", "whitelistDomains": [ "string" ], "createdAt": "string", "updatedAt": "string", "createdByUserId": "string", "updatedByUserId": "string"}How is this guide?