Experiments API - Ours Privacy

Endpoints for managing on-page A/B tests and personalization experiments, including their lifecycle and results.

Endpoints for creating, listing, updating, starting, stopping, pausing, resuming, and inspecting on-page A/B tests and personalization experiments. Variants are managed via the Experiment Variants endpoints. Account-level bootstrap configuration lives on the Experiment Settings endpoints.

Content personalization uses an experiment with type: "personalization" and one DOM-modification or redirect treatment. The API creates the control row automatically, and personalization does not require a primary metric. See Content Personalization for setup guidance.

GET/rest/v1/experiments

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

status?string

Optional lifecycle-state filter.

Value in

"completed"
"draft"
"paused"
"running"

type?string

Optional experiment-type filter.

Value in

"ab"
"multivariate"
"personalization"

search?string

Optional case-insensitive text search matched against experiment ID, name, and description.

Response Body

`application/json`

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

{  "entities": [    {      "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",      "key": "homepage-hero-headline-test",      "name": "Homepage Hero Headline Test",      "description": "Test whether benefit-led copy increases demo requests.",      "type": "ab",      "status": "completed",      "createdAt": "2026-04-30T18:42:11.219Z",      "updatedAt": "string",      "startedAt": "string",      "analysisStartedAt": "string",      "stoppedAt": "string",      "trafficAllocation": 100,      "includeQueryString": false,      "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "targetingRules": {        "urlPatterns": [          "/pricing*",          "get.example.com/learn-more"        ],        "audienceId": "string",        "visitorProperties": {},        "visitorStatus": "string",        "queryParams": [          {            "key": "utm_campaign",            "operator": "contains",            "value": "spring-launch"          }        ]      },      "metrics": {        "primary": {},        "secondary": [          {            "eventName": "demo_requested",            "funnelId": "string"          }        ]      },      "analysisConfig": {},      "analysisMetricSnapshot": {},      "variants": [        {          "id": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",          "experimentId": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",          "name": "Headline Variant B",          "isControl": false,          "weight": 50,          "variantType": "string",          "redirectUrl": "https://www.example.com/pricing-v2",          "domModifications": [            {              "selector": "h1.hero-title",              "action": "customCss",              "value": "Start your free trial",              "styles": [                {                  "property": "background-color",                  "value": "#10B981"                }              ],              "attribute": {}            }          ]        }      ]    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}

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

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

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

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

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

POST/rest/v1/experiments

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

experimentSettingsId*string

ID of the experiment settings record that owns this experiment. Call GET /rest/v1/experiment-settings first if you need to discover the correct ID for the current account.

Length1 <= length

key?|

Optional stable code-facing key. When omitted, the API slugifies the name automatically.

name*string

Short experiment name.

description?|

Optional hypothesis or operator note.

type?|

Experiment mode to create. ab and multivariate use traffic allocation and results; personalization is always-on targeting. Omit to create a standard ab experiment.

Value in

"ab"
"multivariate"
"personalization"

trafficAllocation?|

Initial traffic allocation percentage from 0 to 100.

Range0 <= value <= 100

includeQueryString?|

Whether redirect variants in this experiment should preserve the original request query string.

controlWeight?|

Weight of the auto-created control variant, as a percentage (1–100). Defaults to 100 (a new experiment is all control until treatments are added). The control must keep at least 1% — a 0% control leaves visitors with no bucket to assign at runtime. As treatments are added the control is reconciled to the remainder (100 − Σ treatment weights), so it normally does not need to be set explicitly.

Range1 <= value <= 100

targetingRules?|

Eligibility rules — URL patterns, query-param conditions, visitor status, and visitor-context or accumulated-property rules. Omit to inherit defaults.

metrics?|

Goal events. If you send metrics.primary, metrics.primary.eventName must be a non-blank string. A primary event is required to start ab and multivariate experiments, but not always-on personalization.

analysisConfig?|

Optional draft analysis method. Server-owned statistical constants are normalized before storage.

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/experiments" \  -H "Content-Type: application/json" \  -d '{    "experimentSettingsId": "settings_01HZX9BB73EY2Q37VGK5A0VW7A",    "name": "Homepage Hero Headline Test"  }'

{  "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",  "key": "homepage-hero-headline-test",  "name": "Homepage Hero Headline Test",  "description": "Test whether benefit-led copy increases demo requests.",  "type": "ab",  "status": "completed",  "createdAt": "2026-04-30T18:42:11.219Z",  "updatedAt": "string",  "startedAt": "string",  "analysisStartedAt": "string",  "stoppedAt": "string",  "trafficAllocation": 100,  "includeQueryString": false,  "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "targetingRules": {    "urlPatterns": [      "/pricing*",      "get.example.com/learn-more"    ],    "audienceId": "string",    "visitorProperties": {},    "visitorStatus": "string",    "queryParams": [      {        "key": "utm_campaign",        "operator": "contains",        "value": "spring-launch"      }    ]  },  "metrics": {    "primary": {},    "secondary": [      {        "eventName": "demo_requested",        "funnelId": "string"      }    ]  },  "analysisConfig": {},  "analysisMetricSnapshot": {},  "variants": [    {      "id": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "experimentId": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",      "name": "Headline Variant B",      "isControl": false,      "weight": 50,      "variantType": "string",      "redirectUrl": "https://www.example.com/pricing-v2",      "domModifications": [        {          "selector": "h1.hero-title",          "action": "customCss",          "value": "Start your free trial",          "styles": [            {              "property": "background-color",              "value": "#10B981"            }          ],          "attribute": {}        }      ]    }  ]}

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

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

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

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

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

GET/rest/v1/experiments/{id}

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/experiments/string"

{  "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",  "key": "homepage-hero-headline-test",  "name": "Homepage Hero Headline Test",  "description": "Test whether benefit-led copy increases demo requests.",  "type": "ab",  "status": "completed",  "createdAt": "2026-04-30T18:42:11.219Z",  "updatedAt": "string",  "startedAt": "string",  "analysisStartedAt": "string",  "stoppedAt": "string",  "trafficAllocation": 100,  "includeQueryString": false,  "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "targetingRules": {    "urlPatterns": [      "/pricing*",      "get.example.com/learn-more"    ],    "audienceId": "string",    "visitorProperties": {},    "visitorStatus": "string",    "queryParams": [      {        "key": "utm_campaign",        "operator": "contains",        "value": "spring-launch"      }    ]  },  "metrics": {    "primary": {},    "secondary": [      {        "eventName": "demo_requested",        "funnelId": "string"      }    ]  },  "analysisConfig": {},  "analysisMetricSnapshot": {},  "variants": [    {      "id": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "experimentId": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",      "name": "Headline Variant B",      "isControl": false,      "weight": 50,      "variantType": "string",      "redirectUrl": "https://www.example.com/pricing-v2",      "domModifications": [        {          "selector": "h1.hero-title",          "action": "customCss",          "value": "Start your free trial",          "styles": [            {              "property": "background-color",              "value": "#10B981"            }          ],          "attribute": {}        }      ]    }  ]}

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

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

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

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

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

PATCH/rest/v1/experiments/{id}

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.

key?|

Updated stable code-facing key. When blank, the API falls back to a slugified key derived from the current experiment name. Renaming a non-draft legacy experiment with no stored key preserves its current name-derived key.

name?|

Updated experiment name.

description?|

Updated experiment hypothesis or operator note.

trafficAllocation?|

Updated traffic allocation percentage from 0 to 100.

Range0 <= value <= 100

includeQueryString?|

Updated redirect query-string forwarding behavior for the experiment.

targetingRules?|

Updated eligibility rules. Send the full nested object — replaces the previous value, not merged.

metrics?|

Updated goal events. Send the full nested object — replaces the previous value, not merged. If you send metrics.primary, metrics.primary.eventName must be a non-blank string.

analysisConfig?|

Updated draft analysis method. This field is locked once an experiment starts.

Response Body

`application/json`

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

{  "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",  "key": "homepage-hero-headline-test",  "name": "Homepage Hero Headline Test",  "description": "Test whether benefit-led copy increases demo requests.",  "type": "ab",  "status": "completed",  "createdAt": "2026-04-30T18:42:11.219Z",  "updatedAt": "string",  "startedAt": "string",  "analysisStartedAt": "string",  "stoppedAt": "string",  "trafficAllocation": 100,  "includeQueryString": false,  "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "targetingRules": {    "urlPatterns": [      "/pricing*",      "get.example.com/learn-more"    ],    "audienceId": "string",    "visitorProperties": {},    "visitorStatus": "string",    "queryParams": [      {        "key": "utm_campaign",        "operator": "contains",        "value": "spring-launch"      }    ]  },  "metrics": {    "primary": {},    "secondary": [      {        "eventName": "demo_requested",        "funnelId": "string"      }    ]  },  "analysisConfig": {},  "analysisMetricSnapshot": {},  "variants": [    {      "id": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "experimentId": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",      "name": "Headline Variant B",      "isControl": false,      "weight": 50,      "variantType": "string",      "redirectUrl": "https://www.example.com/pricing-v2",      "domModifications": [        {          "selector": "h1.hero-title",          "action": "customCss",          "value": "Start your free trial",          "styles": [            {              "property": "background-color",              "value": "#10B981"            }          ],          "attribute": {}        }      ]    }  ]}

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

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

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

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

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

DELETE/rest/v1/experiments/{id}

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/experiments/string"

true

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

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

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

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

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

POST/rest/v1/experiments/{id}/start

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.

publishAfterStart?boolean

When true (the default), atomically publish the experiment and its variants as a new version after starting — this is the canonical publish path for experiment changes. Any other unpublished non-experiment changes (destinations, mappings, settings, etc.) currently in draft are included in the same publish. Pass false explicitly to stage the change without publishing; the response will report pending_publish and a separate POST /rest/v1/versions call is then required.

Response Body

`application/json`

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

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

POST/rest/v1/experiments/{id}/stop

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.

Stopping always publishes the new live config immediately so visitors stop being assigned — there is no publishAfterStop flag because deferring the publish would leave a completed experiment still serving traffic. Send {} to stop without a recorded winner; everyone returns to the original unless you also pass rolloutVariantId.

winnerVariantId?string

Optional declared winner to record (reporting metadata only — does not change what visitors are served).

rolloutVariantId?string

Optional variant to roll out to 100% of traffic immediately on stop — the explicit serving decision that keeps the winning experience live (a winning redirect becomes an ongoing redirect). Must be a non-control variant. Reverse later via POST /experiments/{id}/end-rollout.

Response Body

`application/json`

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

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

POST/rest/v1/experiments/{id}/rollout

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.

variantId*string

Non-control variant to roll out to 100% of targeted traffic. The runtime keeps serving it to every matching visitor — a winning redirect becomes an ongoing redirect. Reverse via POST /experiments/{id}/end-rollout. The experiment must be completed.

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/experiments/string/rollout" \  -H "Content-Type: application/json" \  -d '{    "variantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8"  }'

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

POST/rest/v1/experiments/{id}/end-rollout

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/experiments/string/end-rollout"

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

POST/rest/v1/experiments/{id}/winner

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.

Declare, change, or clear the winning variant on a completed experiment. Reporting metadata only — it does not change what visitors see and does not republish. To make the winner live, roll it out via POST /experiments/{id}/rollout.

winnerVariantId?string

Variant to record as the declared winner (reporting metadata only — does not change what visitors are served). Omit to clear the declared winner. The experiment must be completed.

Response Body

`application/json`

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

{  "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",  "key": "homepage-hero-headline-test",  "name": "Homepage Hero Headline Test",  "description": "Test whether benefit-led copy increases demo requests.",  "type": "ab",  "status": "completed",  "createdAt": "2026-04-30T18:42:11.219Z",  "updatedAt": "string",  "startedAt": "string",  "analysisStartedAt": "string",  "stoppedAt": "string",  "trafficAllocation": 100,  "includeQueryString": false,  "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",  "targetingRules": {    "urlPatterns": [      "/pricing*",      "get.example.com/learn-more"    ],    "audienceId": "string",    "visitorProperties": {},    "visitorStatus": "string",    "queryParams": [      {        "key": "utm_campaign",        "operator": "contains",        "value": "spring-launch"      }    ]  },  "metrics": {    "primary": {},    "secondary": [      {        "eventName": "demo_requested",        "funnelId": "string"      }    ]  },  "analysisConfig": {},  "analysisMetricSnapshot": {}}

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

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

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

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

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

POST/rest/v1/experiments/{id}/pause

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.

publishAfterPause?boolean

When true (default on the REST surface), publish the current draft version immediately after pausing the experiment. Any other unpublished changes in the same account version are included in that publish. Pass false explicitly to stage the change without publishing; the response will report pending_publish.

Response Body

`application/json`

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

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

POST/rest/v1/experiments/{id}/resume

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.

publishAfterResume?boolean

When true (default on the REST surface), publish the current draft version immediately after resuming the experiment. Any other unpublished changes in the same account version are included in that publish. Pass false explicitly to stage the change without publishing; the response will report pending_publish.

Response Body

`application/json`

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

{  "publishStatus": "pending_publish",  "concurrentVersionChanges": 1,  "experiment": {    "id": "exp_01HZX8TK6TSN91C5XWZP3N1M4E",    "key": "homepage-hero-headline-test",    "name": "Homepage Hero Headline Test",    "description": "Test whether benefit-led copy increases demo requests.",    "type": "ab",    "status": "completed",    "createdAt": "2026-04-30T18:42:11.219Z",    "updatedAt": "string",    "startedAt": "string",    "analysisStartedAt": "string",    "stoppedAt": "string",    "trafficAllocation": 100,    "includeQueryString": false,    "winnerVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "rolloutVariantId": "var_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",    "targetingRules": {      "urlPatterns": [        "/pricing*",        "get.example.com/learn-more"      ],      "audienceId": "string",      "visitorProperties": {},      "visitorStatus": "string",      "queryParams": [        {          "key": "utm_campaign",          "operator": "contains",          "value": "spring-launch"        }      ]    },    "metrics": {      "primary": {},      "secondary": [        {          "eventName": "demo_requested",          "funnelId": "string"        }      ]    },    "analysisConfig": {},    "analysisMetricSnapshot": {}  }}

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

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

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

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

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

GET/rest/v1/experiments/{id}/results

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

eventName?string

Optional override for the conversion event name. When omitted, the experiment primary metric event is used.

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiments/string/results"

{  "variants": [    {      "id": "string",      "name": "Treatment",      "isControl": false,      "impressions": 1842,      "conversions": 213,      "conversionRate": 0.1156,      "probabilityToBeBest": 0.87    }  ]}

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

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

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

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

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

GET/rest/v1/experiments/{id}/analysis

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

eventName?string

Optional override for the conversion event name. When omitted, the experiment primary metric event is used.

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiments/string/analysis"

{  "method": "BAYESIAN",  "metricType": "conversion",  "analysisState": "ANALYSIS_UNAVAILABLE",  "evidenceState": "EVIDENCE_OF_HARM",  "exploratory": true,  "analysisCutoffAt": "string",  "exposureCutoffAt": "string",  "variants": [    {      "id": "string",      "name": "string",      "isControl": true,      "visitors": 0,      "observedVisitors": 0,      "impressions": 0,      "conversions": 0,      "conversionRate": 0,      "meanValue": 0    }  ],  "bayesian": {},  "frequentist": {},  "sequential": {},  "dataQuality": {    "crossoverVisitors": 0,    "missingVisitorIdImpressions": 0,    "sampleRatioMismatch": "FAIL",    "sampleRatioMismatchPValue": 0  }}

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

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

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

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

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

GET/rest/v1/experiments/{id}/results-time-series

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

eventName?string

Optional override for the conversion event name. When omitted, the experiment primary metric event is used.

startDate?string

Inclusive lower bound of the response window, as a UTC calendar day in YYYY-MM-DD format. Defaults to the experiment start date when omitted. Values before the experiment started are silently clamped to the experiment start.

Match^\d{4}-\d{2}-\d{2}$

endDate?string

Inclusive upper bound of the response window, as a UTC calendar day in YYYY-MM-DD format. Defaults to the experiment stop date for completed experiments, or today for running experiments. Values after that are silently clamped. The window between startDate and endDate must be 366 days or fewer.

Match^\d{4}-\d{2}-\d{2}$

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiments/string/results-time-series"

{  "days": [    {      "date": "2026-04-30",      "variants": [        {          "id": "string",          "impressions": 0,          "conversions": 0,          "conversionRate": 0        }      ]    }  ]}

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

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

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

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

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

GET/rest/v1/experiments/{id}/session-replays

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

limit?|

Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

variant_id?string

Optional filter to a single variant ID. Returns sessions for all variants when omitted.

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/experiments/string/session-replays"

{  "entities": [    {      "sessionId": "sess_01HZX8YJH3Z3W1R2Q4M5N6P7Q8",      "visitorId": "v_01HZX8TK6TSN91C5XWZP3N1M4E",      "variantName": "Variant B",      "startTime": "2026-05-01T18:23:11.000Z",      "durationSeconds": 184,      "pageCount": 5,      "replayUrl": "https://app.oursprivacy.com/session-replay/replayer?sessionId=sess_01HZX8YJH3Z3W1R2Q4M5N6P7Q8&visitorId=v_01HZX8TK6TSN91C5XWZP3N1M4E&date=2026-05-01"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}

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

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

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

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

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

Experiments

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

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

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

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

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/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`

`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`

`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`