> For the complete documentation index, see [llms.txt](https://docs.shoplift.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shoplift.ai/api-reference/models.md).

# Models

## The CampaignStatus object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CampaignStatus":{"enum":["active","completed"]}}}}
```

## The CreateAudienceRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CreateAudienceRequest":{"required":["name","rules"],"type":"object","properties":{"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/CustomAudienceRule"}}},"additionalProperties":false},"CustomAudienceRule":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}},"additionalProperties":false}}}}
```

## The CreateTagRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CreateTagRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}}}
```

## The CreateTestControlRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CreateTestControlRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"suffix":{"type":"string","default":""},"redirectUrl":{"type":["null","string"]},"themeId":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false}}}}
```

## The CreateTestRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CreateTestRequest":{"required":["title","type","control","variant","goal","device","visitorOption","controlTraffic","hypothesisDescription","defaultAudiences","customAudienceIds","automaticallyStartAt","automaticallyEndAt"],"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string"},"control":{"$ref":"#/components/schemas/CreateTestControlRequest"},"variant":{"$ref":"#/components/schemas/CreateTestVariantRequest"},"goal":{"type":["null","string"]},"device":{"type":["null","string"]},"visitorOption":{"type":["null","string"]},"controlTraffic":{"type":["null","integer"],"format":"int32"},"hypothesisDescription":{"type":["null","string"]},"defaultAudiences":{"type":["null","array"],"items":{"type":"string"}},"customAudienceIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}},"automaticallyStartAt":{"type":["null","string"],"format":"date-time"},"automaticallyEndAt":{"type":["null","string"],"format":"date-time"},"endWhenSignificant":{"type":"boolean","default":false},"campaignId":{"type":["null","string"],"format":"uuid"},"priority":{"type":["null","string"]},"surfaceArea":{"type":["null","string"]},"impact":{"type":["null","integer"],"format":"int32"},"effort":{"type":["null","integer"],"format":"int32"},"tagIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"CreateTestControlRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"suffix":{"type":"string","default":""},"redirectUrl":{"type":["null","string"]},"themeId":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"CreateTestVariantRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"mode":{"type":["null","string"]},"source":{"type":"string","default":""},"themeId":{"type":["null","integer"],"format":"int64"},"redirectUrl":{"type":["null","string"]},"granular":{"type":"boolean","default":false}},"additionalProperties":false}}}}
```

## The CreateTestVariantRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CreateTestVariantRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"mode":{"type":["null","string"]},"source":{"type":"string","default":""},"themeId":{"type":["null","integer"],"format":"int64"},"redirectUrl":{"type":["null","string"]},"granular":{"type":"boolean","default":false}},"additionalProperties":false}}}}
```

## The CustomAudienceRule object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"CustomAudienceRule":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}},"additionalProperties":false}}}}
```

## The ExperienceStage object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExperienceStage":{"enum":["idea","ready","scheduled","live","paused","ended"]}}}}
```

## The ExternalActiveCampaignsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalActiveCampaignsResponse":{"required":["campaigns"],"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/ExternalCampaignItem"}}}},"ExternalCampaignItem":{"required":["id","name","objective","goal","status","createdAt","progress"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"objective":{"type":["null","string"]},"goal":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfCampaignGoal"}]},"status":{"$ref":"#/components/schemas/CampaignStatus"},"createdAt":{"type":"string","format":"date-time"},"progress":{"$ref":"#/components/schemas/ExternalCampaignProgress"}}},"NullableOfCampaignGoal":{"enum":["aov","cvr","rpv","ctr","atc",null]},"CampaignStatus":{"enum":["active","completed"]},"ExternalCampaignProgress":{"required":["total","live","paused","draft","ended"],"type":"object","properties":{"total":{"type":"integer","format":"int32"},"live":{"type":"integer","format":"int32"},"paused":{"type":"integer","format":"int32"},"draft":{"type":"integer","format":"int32"},"ended":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalAudienceItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalAudienceItem":{"required":["id","name","rules"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceRuleItem"}}}},"ExternalAudienceRuleItem":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}}}}}}
```

## The ExternalAudienceRuleItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalAudienceRuleItem":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}}}}}}
```

## The ExternalAudiencesResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalAudiencesResponse":{"required":["customAudiences"],"type":"object","properties":{"customAudiences":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceItem"}}}},"ExternalAudienceItem":{"required":["id","name","rules"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceRuleItem"}}}},"ExternalAudienceRuleItem":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}}}}}}
```

## The ExternalCampaignItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalCampaignItem":{"required":["id","name","objective","goal","status","createdAt","progress"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"objective":{"type":["null","string"]},"goal":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfCampaignGoal"}]},"status":{"$ref":"#/components/schemas/CampaignStatus"},"createdAt":{"type":"string","format":"date-time"},"progress":{"$ref":"#/components/schemas/ExternalCampaignProgress"}}},"NullableOfCampaignGoal":{"enum":["aov","cvr","rpv","ctr","atc",null]},"CampaignStatus":{"enum":["active","completed"]},"ExternalCampaignProgress":{"required":["total","live","paused","draft","ended"],"type":"object","properties":{"total":{"type":"integer","format":"int32"},"live":{"type":"integer","format":"int32"},"paused":{"type":"integer","format":"int32"},"draft":{"type":"integer","format":"int32"},"ended":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalCampaignProgress object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalCampaignProgress":{"required":["total","live","paused","draft","ended"],"type":"object","properties":{"total":{"type":"integer","format":"int32"},"live":{"type":"integer","format":"int32"},"paused":{"type":"integer","format":"int32"},"draft":{"type":"integer","format":"int32"},"ended":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalCampaignRef object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalCampaignRef":{"required":["id","name","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CampaignStatus"}}},"CampaignStatus":{"enum":["active","completed"]}}}}
```

## The ExternalDailyEntry object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalDailyEntry":{"required":["performance"],"type":"object","properties":{"performance":{"$ref":"#/components/schemas/ExternalDailyPerformance"}}},"ExternalDailyPerformance":{"required":["control","variant"],"type":"object","properties":{"control":{"$ref":"#/components/schemas/ExternalTestSideStats"},"variant":{"$ref":"#/components/schemas/ExternalTestSideStats"}}},"ExternalTestSideStats":{"required":["visitors","visits","clicks","carts","conversions","orders","totalOrders","totalConversions","initialSubscriptionConversions","initialSubscriptionOrders","initialSubscriptionRevenue","cnv","aov","rps","ctr","acr","revenue","totalRevenue","mobile","desktop","new","returning"],"type":"object","properties":{"visitors":{"type":"integer","format":"int32"},"visits":{"type":"integer","format":"int32"},"clicks":{"type":"integer","format":"int32"},"carts":{"type":"integer","format":"int32"},"conversions":{"type":"integer","format":"int32"},"orders":{"type":"integer","format":"int32"},"totalOrders":{"type":"integer","format":"int32"},"totalConversions":{"type":"integer","format":"int32"},"initialSubscriptionConversions":{"type":"integer","format":"int32"},"initialSubscriptionOrders":{"type":"integer","format":"int32"},"initialSubscriptionRevenue":{"type":"number","format":"double"},"cnv":{"type":"number","format":"double"},"aov":{"type":"number","format":"double"},"rps":{"type":"number","format":"double"},"ctr":{"type":"number","format":"double"},"acr":{"type":"number","format":"double"},"revenue":{"type":"number","format":"double"},"totalRevenue":{"type":"number","format":"double"},"mobile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"desktop":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"new":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"returning":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]}}}}}}
```

## The ExternalDailyPerformance object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalDailyPerformance":{"required":["control","variant"],"type":"object","properties":{"control":{"$ref":"#/components/schemas/ExternalTestSideStats"},"variant":{"$ref":"#/components/schemas/ExternalTestSideStats"}}},"ExternalTestSideStats":{"required":["visitors","visits","clicks","carts","conversions","orders","totalOrders","totalConversions","initialSubscriptionConversions","initialSubscriptionOrders","initialSubscriptionRevenue","cnv","aov","rps","ctr","acr","revenue","totalRevenue","mobile","desktop","new","returning"],"type":"object","properties":{"visitors":{"type":"integer","format":"int32"},"visits":{"type":"integer","format":"int32"},"clicks":{"type":"integer","format":"int32"},"carts":{"type":"integer","format":"int32"},"conversions":{"type":"integer","format":"int32"},"orders":{"type":"integer","format":"int32"},"totalOrders":{"type":"integer","format":"int32"},"totalConversions":{"type":"integer","format":"int32"},"initialSubscriptionConversions":{"type":"integer","format":"int32"},"initialSubscriptionOrders":{"type":"integer","format":"int32"},"initialSubscriptionRevenue":{"type":"number","format":"double"},"cnv":{"type":"number","format":"double"},"aov":{"type":"number","format":"double"},"rps":{"type":"number","format":"double"},"ctr":{"type":"number","format":"double"},"acr":{"type":"number","format":"double"},"revenue":{"type":"number","format":"double"},"totalRevenue":{"type":"number","format":"double"},"mobile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"desktop":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"new":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"returning":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]}}}}}}
```

## The ExternalDefaultAudienceItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalDefaultAudienceItem":{"required":["id","name","dimension","operator","value"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"dimension":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The ExternalLiftByMetric object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalLiftByMetric":{"required":["value"],"type":"object","properties":{"value":{"type":"number","format":"float"}}}}}}
```

## The ExternalPaginationMeta object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalPaginationMeta":{"required":["page","perPage","totalPages","totalCount"],"type":"object","properties":{"page":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalTagItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTagItem":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}}}}}
```

## The ExternalTagsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTagsResponse":{"required":["tags"],"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTagItem"}}}},"ExternalTagItem":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}}}}}
```

## The ExternalTestControlItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestControlItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalTestItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestItem":{"required":["id","title","control","variant","status","goal","device","visitorOption","hypothesisDescription","campaign","handle","duration","period","createdAt","updatedAt","startAt","endAt","appliedAt","automaticallyStartAt","automaticallyEndAt","automaticallyPauseAt","automaticallyResumeAt","endWhenSignificant","estimatedCompletionDate","customAudiences","defaultAudiences","stage","tags","priority","surfaceArea","impact","effort","implemented"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"control":{"$ref":"#/components/schemas/ExternalTestControlItem"},"variant":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestVariantItem"}]},"status":{"$ref":"#/components/schemas/ExternalTestStatus"},"goal":{"type":"string"},"device":{"type":"string"},"visitorOption":{"type":"string"},"hypothesisDescription":{"type":["null","string"]},"campaign":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalCampaignRef"}]},"handle":{"type":["null","string"]},"duration":{"type":["null","number"],"format":"double"},"period":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"startAt":{"type":["null","string"],"format":"date-time"},"endAt":{"type":["null","string"],"format":"date-time"},"appliedAt":{"type":["null","string"],"format":"date-time"},"automaticallyStartAt":{"type":["null","string"],"format":"date-time"},"automaticallyEndAt":{"type":["null","string"],"format":"date-time"},"automaticallyPauseAt":{"type":["null","string"],"format":"date-time"},"automaticallyResumeAt":{"type":["null","string"],"format":"date-time"},"endWhenSignificant":{"type":"boolean"},"estimatedCompletionDate":{"type":["null","string"],"format":"date-time"},"customAudiences":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceItem"}},"defaultAudiences":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDefaultAudienceItem"}},"stage":{"$ref":"#/components/schemas/ExperienceStage"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTagItem"}},"priority":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfPriority"}]},"surfaceArea":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfSurfaceArea"}]},"impact":{"type":["null","integer"],"format":"int32"},"effort":{"type":["null","integer"],"format":"int32"},"implemented":{"type":["null","boolean"]}}},"ExternalTestControlItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}},"ExternalTestVariantItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}},"ExternalTestStatus":{"enum":["draft","scheduled","active","paused","suspended","incompatible","cancelled","completed"]},"ExternalCampaignRef":{"required":["id","name","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CampaignStatus"}}},"CampaignStatus":{"enum":["active","completed"]},"ExternalAudienceItem":{"required":["id","name","rules"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceRuleItem"}}}},"ExternalAudienceRuleItem":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}}},"ExternalDefaultAudienceItem":{"required":["id","name","dimension","operator","value"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"dimension":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}},"ExperienceStage":{"enum":["idea","ready","scheduled","live","paused","ended"]},"ExternalTagItem":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"NullableOfPriority":{"enum":["low","medium","high","critical",null]},"NullableOfSurfaceArea":{"enum":["global","homepage","pdp","plp","cart","landingPage","navigation","other",null]}}}}
```

## The ExternalTestListResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestListResponse":{"required":["data","pagination"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTestItem"}},"pagination":{"$ref":"#/components/schemas/ExternalPaginationMeta"}}},"ExternalTestItem":{"required":["id","title","control","variant","status","goal","device","visitorOption","hypothesisDescription","campaign","handle","duration","period","createdAt","updatedAt","startAt","endAt","appliedAt","automaticallyStartAt","automaticallyEndAt","automaticallyPauseAt","automaticallyResumeAt","endWhenSignificant","estimatedCompletionDate","customAudiences","defaultAudiences","stage","tags","priority","surfaceArea","impact","effort","implemented"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"control":{"$ref":"#/components/schemas/ExternalTestControlItem"},"variant":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestVariantItem"}]},"status":{"$ref":"#/components/schemas/ExternalTestStatus"},"goal":{"type":"string"},"device":{"type":"string"},"visitorOption":{"type":"string"},"hypothesisDescription":{"type":["null","string"]},"campaign":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalCampaignRef"}]},"handle":{"type":["null","string"]},"duration":{"type":["null","number"],"format":"double"},"period":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"startAt":{"type":["null","string"],"format":"date-time"},"endAt":{"type":["null","string"],"format":"date-time"},"appliedAt":{"type":["null","string"],"format":"date-time"},"automaticallyStartAt":{"type":["null","string"],"format":"date-time"},"automaticallyEndAt":{"type":["null","string"],"format":"date-time"},"automaticallyPauseAt":{"type":["null","string"],"format":"date-time"},"automaticallyResumeAt":{"type":["null","string"],"format":"date-time"},"endWhenSignificant":{"type":"boolean"},"estimatedCompletionDate":{"type":["null","string"],"format":"date-time"},"customAudiences":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceItem"}},"defaultAudiences":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDefaultAudienceItem"}},"stage":{"$ref":"#/components/schemas/ExperienceStage"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTagItem"}},"priority":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfPriority"}]},"surfaceArea":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/NullableOfSurfaceArea"}]},"impact":{"type":["null","integer"],"format":"int32"},"effort":{"type":["null","integer"],"format":"int32"},"implemented":{"type":["null","boolean"]}}},"ExternalTestControlItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}},"ExternalTestVariantItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}},"ExternalTestStatus":{"enum":["draft","scheduled","active","paused","suspended","incompatible","cancelled","completed"]},"ExternalCampaignRef":{"required":["id","name","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CampaignStatus"}}},"CampaignStatus":{"enum":["active","completed"]},"ExternalAudienceItem":{"required":["id","name","rules"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAudienceRuleItem"}}}},"ExternalAudienceRuleItem":{"required":["dimension","operator","values"],"type":"object","properties":{"dimension":{"type":"string"},"operator":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"selector":{"type":["null","string"]}}},"ExternalDefaultAudienceItem":{"required":["id","name","dimension","operator","value"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"dimension":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}},"ExperienceStage":{"enum":["idea","ready","scheduled","live","paused","ended"]},"ExternalTagItem":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"NullableOfPriority":{"enum":["low","medium","high","critical",null]},"NullableOfSurfaceArea":{"enum":["global","homepage","pdp","plp","cart","landingPage","navigation","other",null]},"ExternalPaginationMeta":{"required":["page","perPage","totalPages","totalCount"],"type":"object","properties":{"page":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalTestResultsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestResultsResponse":{"required":["id","status","totalSessions","controlSplit","variantSplit","winner","bayesianModelStatus","bayesianModelTrend","hasSufficientSamples","progress","lift","changeRevenue","controlProbabilityWin","variantProbabilityWin","liftByMetric","control","variant","daily"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/ExternalTestStatus"},"totalSessions":{"type":"integer","format":"int32"},"controlSplit":{"type":"integer","format":"int32"},"variantSplit":{"type":"integer","format":"int32"},"winner":{"type":["null","string"]},"bayesianModelStatus":{"type":["null","string"]},"bayesianModelTrend":{"type":["null","string"]},"hasSufficientSamples":{"type":"boolean"},"progress":{"type":"number","format":"float"},"lift":{"type":"number","format":"float"},"changeRevenue":{"type":"number","format":"float"},"controlProbabilityWin":{"type":"number","format":"float"},"variantProbabilityWin":{"type":"number","format":"float"},"liftByMetric":{"$ref":"#/components/schemas/IReadOnlyDictionaryOfInt32AndExternalLiftByMetric"},"control":{"$ref":"#/components/schemas/ExternalTestSideStats"},"variant":{"$ref":"#/components/schemas/ExternalTestSideStats"},"daily":{"$ref":"#/components/schemas/IReadOnlyDictionaryOfStringAndExternalDailyEntry"}}},"ExternalTestStatus":{"enum":["draft","scheduled","active","paused","suspended","incompatible","cancelled","completed"]},"IReadOnlyDictionaryOfInt32AndExternalLiftByMetric":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalLiftByMetric"}},"ExternalLiftByMetric":{"required":["value"],"type":"object","properties":{"value":{"type":"number","format":"float"}}},"ExternalTestSideStats":{"required":["visitors","visits","clicks","carts","conversions","orders","totalOrders","totalConversions","initialSubscriptionConversions","initialSubscriptionOrders","initialSubscriptionRevenue","cnv","aov","rps","ctr","acr","revenue","totalRevenue","mobile","desktop","new","returning"],"type":"object","properties":{"visitors":{"type":"integer","format":"int32"},"visits":{"type":"integer","format":"int32"},"clicks":{"type":"integer","format":"int32"},"carts":{"type":"integer","format":"int32"},"conversions":{"type":"integer","format":"int32"},"orders":{"type":"integer","format":"int32"},"totalOrders":{"type":"integer","format":"int32"},"totalConversions":{"type":"integer","format":"int32"},"initialSubscriptionConversions":{"type":"integer","format":"int32"},"initialSubscriptionOrders":{"type":"integer","format":"int32"},"initialSubscriptionRevenue":{"type":"number","format":"double"},"cnv":{"type":"number","format":"double"},"aov":{"type":"number","format":"double"},"rps":{"type":"number","format":"double"},"ctr":{"type":"number","format":"double"},"acr":{"type":"number","format":"double"},"revenue":{"type":"number","format":"double"},"totalRevenue":{"type":"number","format":"double"},"mobile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"desktop":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"new":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"returning":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]}}},"IReadOnlyDictionaryOfStringAndExternalDailyEntry":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalDailyEntry"}},"ExternalDailyEntry":{"required":["performance"],"type":"object","properties":{"performance":{"$ref":"#/components/schemas/ExternalDailyPerformance"}}},"ExternalDailyPerformance":{"required":["control","variant"],"type":"object","properties":{"control":{"$ref":"#/components/schemas/ExternalTestSideStats"},"variant":{"$ref":"#/components/schemas/ExternalTestSideStats"}}}}}}
```

## The ExternalTestSideStats object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestSideStats":{"required":["visitors","visits","clicks","carts","conversions","orders","totalOrders","totalConversions","initialSubscriptionConversions","initialSubscriptionOrders","initialSubscriptionRevenue","cnv","aov","rps","ctr","acr","revenue","totalRevenue","mobile","desktop","new","returning"],"type":"object","properties":{"visitors":{"type":"integer","format":"int32"},"visits":{"type":"integer","format":"int32"},"clicks":{"type":"integer","format":"int32"},"carts":{"type":"integer","format":"int32"},"conversions":{"type":"integer","format":"int32"},"orders":{"type":"integer","format":"int32"},"totalOrders":{"type":"integer","format":"int32"},"totalConversions":{"type":"integer","format":"int32"},"initialSubscriptionConversions":{"type":"integer","format":"int32"},"initialSubscriptionOrders":{"type":"integer","format":"int32"},"initialSubscriptionRevenue":{"type":"number","format":"double"},"cnv":{"type":"number","format":"double"},"aov":{"type":"number","format":"double"},"rps":{"type":"number","format":"double"},"ctr":{"type":"number","format":"double"},"acr":{"type":"number","format":"double"},"revenue":{"type":"number","format":"double"},"totalRevenue":{"type":"number","format":"double"},"mobile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"desktop":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"new":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"returning":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]}}}}}}
```

## The ExternalTestStatus object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestStatus":{"enum":["draft","scheduled","active","paused","suspended","incompatible","cancelled","completed"]}}}}
```

## The ExternalTestVariantItem object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ExternalTestVariantItem":{"required":["id","type","suffix","themeId","redirectUrl","screenshotUrl","title","traffic"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"suffix":{"type":"string"},"themeId":{"type":"integer","format":"int64"},"redirectUrl":{"type":["null","string"]},"screenshotUrl":{"type":["null","string"]},"title":{"type":["null","string"]},"traffic":{"type":"integer","format":"int32"}}}}}}
```

## The IdResponse object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"IdResponse":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The IReadOnlyDictionaryOfInt32AndExternalLiftByMetric object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"IReadOnlyDictionaryOfInt32AndExternalLiftByMetric":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalLiftByMetric"}},"ExternalLiftByMetric":{"required":["value"],"type":"object","properties":{"value":{"type":"number","format":"float"}}}}}}
```

## The IReadOnlyDictionaryOfStringAndExternalDailyEntry object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"IReadOnlyDictionaryOfStringAndExternalDailyEntry":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalDailyEntry"}},"ExternalDailyEntry":{"required":["performance"],"type":"object","properties":{"performance":{"$ref":"#/components/schemas/ExternalDailyPerformance"}}},"ExternalDailyPerformance":{"required":["control","variant"],"type":"object","properties":{"control":{"$ref":"#/components/schemas/ExternalTestSideStats"},"variant":{"$ref":"#/components/schemas/ExternalTestSideStats"}}},"ExternalTestSideStats":{"required":["visitors","visits","clicks","carts","conversions","orders","totalOrders","totalConversions","initialSubscriptionConversions","initialSubscriptionOrders","initialSubscriptionRevenue","cnv","aov","rps","ctr","acr","revenue","totalRevenue","mobile","desktop","new","returning"],"type":"object","properties":{"visitors":{"type":"integer","format":"int32"},"visits":{"type":"integer","format":"int32"},"clicks":{"type":"integer","format":"int32"},"carts":{"type":"integer","format":"int32"},"conversions":{"type":"integer","format":"int32"},"orders":{"type":"integer","format":"int32"},"totalOrders":{"type":"integer","format":"int32"},"totalConversions":{"type":"integer","format":"int32"},"initialSubscriptionConversions":{"type":"integer","format":"int32"},"initialSubscriptionOrders":{"type":"integer","format":"int32"},"initialSubscriptionRevenue":{"type":"number","format":"double"},"cnv":{"type":"number","format":"double"},"aov":{"type":"number","format":"double"},"rps":{"type":"number","format":"double"},"ctr":{"type":"number","format":"double"},"acr":{"type":"number","format":"double"},"revenue":{"type":"number","format":"double"},"totalRevenue":{"type":"number","format":"double"},"mobile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"desktop":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"new":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]},"returning":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExternalTestSideStats"}]}}}}}}
```

## The NullableOfCampaignGoal object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"NullableOfCampaignGoal":{"enum":["aov","cvr","rpv","ctr","atc",null]}}}}
```

## The NullableOfExternalTestStatus object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"NullableOfExternalTestStatus":{"enum":["draft","scheduled","active","paused","suspended","incompatible","cancelled","completed",null]}}}}
```

## The NullableOfPriority object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"NullableOfPriority":{"enum":["low","medium","high","critical",null]}}}}
```

## The NullableOfSurfaceArea object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"NullableOfSurfaceArea":{"enum":["global","homepage","pdp","plp","cart","landingPage","navigation","other",null]}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}}}}}}
```

## The UpdateTestRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"UpdateTestRequest":{"type":"object","properties":{"title":{"type":["null","string"]},"hypothesisDescription":{"type":["null","string"]},"controlTitle":{"type":["null","string"]},"variantTitle":{"type":["null","string"]},"goal":{"type":["null","string"]},"device":{"type":["null","string"]},"visitorOption":{"type":["null","string"]},"controlTraffic":{"type":["null","integer"],"format":"int32"},"defaultAudiences":{"type":["null","array"],"items":{"type":"string"}},"customAudienceIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}},"campaignId":{"type":["null","string"],"format":"uuid"},"variant":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/UpdateTestVariantRequest"}]},"automaticallyStartAt":{"type":["null","string"],"format":"date-time"},"automaticallyEndAt":{"type":["null","string"],"format":"date-time"},"endWhenSignificant":{"type":["null","boolean"]},"priority":{"type":["null","string"]},"surfaceArea":{"type":["null","string"]},"impact":{"type":["null","integer"],"format":"int32"},"effort":{"type":["null","integer"],"format":"int32"},"implemented":{"type":["null","boolean"]},"tagIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"UpdateTestVariantRequest":{"type":"object","properties":{"mode":{"type":["null","string"]},"source":{"type":["null","string"]},"type":{"type":["null","string"]},"themeId":{"type":["null","integer"],"format":"int64"},"redirectUrl":{"type":["null","string"]},"granular":{"type":["null","boolean"]}},"additionalProperties":false}}}}
```

## The UpdateTestVariantRequest object

```json
{"openapi":"3.1.1","info":{"title":"Shoplift Public API","version":"1.0.0"},"components":{"schemas":{"UpdateTestVariantRequest":{"type":"object","properties":{"mode":{"type":["null","string"]},"source":{"type":["null","string"]},"type":{"type":["null","string"]},"themeId":{"type":["null","integer"],"format":"int64"},"redirectUrl":{"type":["null","string"]},"granular":{"type":["null","boolean"]}},"additionalProperties":false}}}}
```