Convert Experience Variations API
Each **Experience** has one or more **Variations** which are presented to different groups of visitorin order to monitor the results of different changes or to personalize visitor's experience
Convert Experience Variations API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Experience Variations. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 4 paths, and defines 240 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 3 base URLs: https://api.convert.com/api/v2, https://apidev.convert.com/api/v2, http://apidev.convert.com:5000/api/v2.
5 operations
4 paths
240 schemas
1 DELETE1 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Convert Experience Variations API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (requestSigning).
It accepts HTTP bearer tokens (secretKey).
An API key is passed in the cookie as sid (cookieAuthentication).
requestSigning— See [API Key Authentication](tag/API-KEY-Authentication) for more information.secretKey— See [API Key Authentication](tag/API-KEY-Authentication) for more information.cookieAuthentication— Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the "[Cookie Authentication](ta…
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Experience Variations 5
Each Experience has one or more Variations which are presented to different groups of visitor in order to monitor the results of different changes or to personalize visitor's expe…
PUT
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/update
Update an experience variation
DELETE
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/delete
Delete an experience variation
GET
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/screenshot
Get screenshot for an experience variation
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/screenshot
Upload a screenshot for an experience variation
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/convert
Convert a winning variation into a new experience (Deploy or A/B)
Schemas 240
The contract defines 240 schemas that model the data the API accepts and returns. The most detailed are ExperienceBase (20 properties), ExperienceReportingSettings (18 properties), BaseProject (12 properties), GoalBase (9 properties). Each schema is shown below with its type and property counts.
SE_ProcTypes
string
The statistical methodology used for analyzing experiment results and determining winners. - frequentist: Traditional hypothesis testing approach using p-value…
BaseRuleWithBrowserNameValue
AudienceTypesWithUrl
string
Defines the behavior for an audience that includes URL-based conditions in its rules. - segmentation: Once a visitor matches the audience criteria (which can i…
ExperienceChangeId
object
Represents the unique identifier of an existing change within an experience variation. Used when updating or referencing a specific change.
1 property
1 required
BaseRuleWithSegmentBucketedValue
ExperienceChangeBase
object
The fundamental structure representing a single modification applied within an experience's variation. The specific content and behavior of the change are dete…
2 properties
GenericTextKeyValueMatchRule
DayOfWeekMatchRule
WeatherConditionMatchRulesTypes
string
GenericBoolMatchRule
IntegrationGA3
object
2 properties
ExperienceChangeFullStackFeatureUpdate
object
Data for updating an existing 'fullStackFeature' type change, identified by its id.
ExperienceVariationBaseExtended
ExperienceIntegrationGoogleAnalytics
ExperienceChangeDefaultRedirectData
object
Represents a 'defaultRedirect' type change, including its system-assigned ID.
ConvertExperienceVariationRequestData
object
Request parameters for converting an existing variation into a new, standalone experience.
1 property
GenericListMatchingOptions
string
Defines how multiple conditions within a list (e.g., multiple audiences or locations linked to an experience) are logically combined: - any: The overall condit…
TrackingScriptReleaseLatest
TextMatchingOptions
string
MinuteOfHourMatchRulesTypes
string
SimpleLocation
object
2 properties
TagExpandable
Represents a tag, either as its unique ID or as the full tag object (ID, name, description) if expanded.
ExperienceIntegrationClicky
BaseProject
object
12 properties
ExperienceChangeDefaultRedirectDataAdd
object
Data for creating a new 'defaultRedirect' type change.
GenericTextKeyValueMatchRulesTypes
string
ExperienceChangeDefaultCodeMultipageDataAdd
object
Data for creating a new 'defaultCodeMultipage' type change.
ExperienceChangeDefaultCodeDataBase
object
Defines a standard code-based change, typically generated by the Visual Editor for modifications like text replacement, style changes, or element removal. It c…
TextMatchRulesTypes
string
BaseRuleWithMinuteOfHourValue
ExperienceStatuses
string
GoalStatuses
string
The current status of a goal: - active: The goal is active and will track conversions for experiences it's attached to. - archived: The goal is archived and wi…
Project
Represents a Convert project, which is a container for organizing a set of related optimization activities (experiences), their goals, target audiences, associ…
ExperienceVariationStatuses
string
ExperienceVariation
GA_SettingsBase
object
1 property
GenericBoolKeyValueMatchRule
ExperienceChangeDefaultRedirectDataBase
object
Defines a URL redirect, typically used in Split URL experiments. It specifies how to match an original URL and construct the URL for the variation page.
NumericOutlier
BaseRuleWithOsValue
ExperienceIntegrationCrazyegg
Configuration for integrating with Crazy Egg. Convert sends experiment and variation data to allow segmentation of Crazy Egg heatmaps and recordings by variati…
UserCustomization
object
A generic key-value pair for storing miscellaneous user-specific UI customizations or settings not covered by structured preferences.
2 properties
2 required
ScrollPercentageGoalSettings
object
1 property
1 required
CustomDomainOwnershipVerificationItem
object
3 properties
CollapsedExperienceVariationData
BaseRuleWithStringValue
GenericNumericKeyValueMatchRule
ProjectStatuses
string
The overall status of a project: - active: The project is active, and experiences within it can run and track data. - inactive: The project is inactive (archiv…
RuleObject
object
Defines the logical structure for combining multiple rule conditions. It uses a nested OR - AND - ORWHEN structure. - The top-level OR array means if any of it…
1 property
RuleObjectAudience
object
This one describes a logical rule that is being used inside the app for triggering goals, matching audiences etc
1 property
LocationTriggerTypes
string
Specifies the mechanism that activates an experience when its location rules are met: - uponrun: (Default) The experience activates as soon as the Convert trac…
DayOfWeekMatchRulesTypes
string
VisitorTypeMatchRule
ExperienceChangeRichStructureDataUpdate
object
Data for updating an existing 'richStructure' type change, identified by its id.
ExperienceIntegrationEconda
JsConditionMatchRulesTypes
string
NumericOutlierPercentile
LanguageMatchRulesTypes
string
ExperienceUserCustomizations
array
A list of user-defined key-value pairs for customizing UI elements or behavior related to this experience within the Convert application itself. These do not a…
BaseMatch
object
1 property
ExperienceChangeDefaultCodeData
object
Represents a 'defaultCode' type change, including its system-assigned ID.
VisualEditorUserAgents
string
Predefined User-Agent strings that the Visual Editor can emulate for responsive design and device-specific testing.
MultipageExperiencePage
Defines a single page within a 'multipage' (funnel) experience.
LocationDomTriggerEvents
string
The type of user interaction with a DOM element that will trigger the experience: - click: Activates when the element is clicked. - hover: Activates when the m…
RuleElement
GenerateDebugTokenData
object
2 properties
ExperienceChangeRichStructureData
object
Represents a 'richStructure' type change, including its system-assigned ID.
ExperienceChangeDefaultCodeDataAdd
object
Data for creating a new 'defaultCode' type change.
GenericTextMatchRule
GenericNumericMatchRule
ExperienceIntegrationGA4Base
Percentiles
number
Standard percentile values used for outlier detection thresholds. For example, a min of 5 and max of 95 means orders in the bottom 5% and top 5% of values are…
CookieMatchingOptions
string
RuleElementNoUrl
Location
ExperienceSettings
SE_ProcSettingsBayesian
ErrorData
object
3 properties
VisitorDataExistsMatchRulesTypes
string
MetricTypes
string
The primary types of performance metrics calculated by the reporting engine for each goal. - conversionrate: The percentage of visitors who completed the goal…
RevenueGoalSettings
object
1 property
1 required
UTC_Offset
integer
The time offset from Coordinated Universal Time (UTC) in seconds. For example, UTC-5 (EST) would be -18000. UTC+2 would be 7200. Used for interpreting or displ…
ExpandedExperienceVariationData
RuleObjectNoUrl
object
Similar to RuleObject, but the individual RuleElementNoUrl conditions within ORWHEN arrays cannot include URL-based matching types. Used for 'permanent' or 'tr…
1 property
ExperienceBase
object
20 properties
UpdateExperienceVariationRequestData
SimpleAudienceExpandable
CountryMatchRulesTypes
string
HourOfDayMatchRulesTypes
string
UploadImageNoNameRequestData
object
Request body for uploading an image where the filename might be derived from the uploaded file or generated by the system. Uses multipart/form-data. Typically…
1 property
1 required
BaseRuleWithGoalTriggeredValue
ExperienceIntegrationSitecatalyst
WeatherConditionMatchRule
ExperienceChangeFullStackFeature
object
Represents a 'fullStackFeature' type change, including its system-assigned ID.
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
ExperienceChangeCustomCodeDataUpdate
object
Data for updating an existing 'customCode' type change, identified by its id.
ExperienceIntegrationHotjar
LocationStatuses
string
The current status of a location: - active: The location is active and can be used for targeting experiences. - archived: The location is archived and no longe…
TrackingScriptReleaseManual
AdvancedGoal
ExperienceChangeIdReadOnly
object
Represents the unique identifier of a change, typically when returned by the API after creation or in a list.
1 property
ClicksLinkGoal
SimpleLocationExpandable
Audience
ExperienceAlert
object
3 properties
BaseRuleWithCountryCodeValue
BrowserNameMatchRule
DomInteractionGoalSettings
object
1 property
1 required
ExperienceChangeFullStackFeatureBase
object
Defines a change for a Full Stack experiment that involves enabling or configuring a specific 'Feature' and its variables for this variation.
GA_Settings
AudienceWithUrlMatching
ExperienceIntegrationPiwik
SE_MabSettings
object
Configuration for Multi-Armed Bandit (MAB) traffic allocation. If null, MAB is disabled and manual traffic allocation is used. MAB dynamically allocates more t…
2 properties
ExperienceChangeDefaultRedirectDataUpdate
object
Data for updating an existing 'defaultRedirect' type change, identified by its id.
ExperienceChangeCustomCodeDataBase
object
Defines a change applied purely through custom-written CSS and/or JavaScript code, bypassing the Visual Editor's generated code. This offers maximum flexibilit…
AudienceTypesNoUrl
string
Defines the behavior and persistence of an audience that does not use URL-based conditions in its rules. - permanent: Once a visitor matches the audience crite…
SubmitsFormGoal
ExperienceIntegrationSegmentio
NumericOutlierNone
ExperienceIntegrationGosquared
BaseRuleWithJsCodeValue
LocationTriggerBase
object
1 property
1 required
ExperienceIntegrationMouseflow
GoalTriggeredMatchRulesTypes
string
SimpleGoal
object
2 properties
SegmentBucketedMatchRule
SuccessData
object
2 properties
LocationRuleElement
TrackingScriptReleaseAutomaticApplyOn
object
Configuration for scheduled tracking script updates, specifying the day of the week and time for automatic application of new versions.
2 properties
2 required
VisitorTypeMatchRulesTypes
string
ExperienceChangeRichStructureDataBase
object
Defines a complex change, often involving multiple DOM manipulations or structured data, typically generated by advanced Visual Editor interactions or specific…
BrowserNameMatchRulesTypes
string
IntegrationGA4
BaseRuleWithBooleanValue
ProjectGASettingsBase
GaGoalSettings
object
1 property
SimpleGoalExpandable
LocationTriggerUponRun
ScrollPercentageGoal
ExperienceCollaborator
object
5 properties
SegmentBucketedMatchRulesTypes
string
ClicksLinkGoalSettings
object
1 property
1 required
MinuteOfHourMatchRule
AccessRoleNames
string
The predefined names for user access roles within the Convert system. Each role grants a specific set of permissions. - owner: Highest level, full control over…
ExperienceIntegrationClicktale
ExperienceChangeFullStackFeatureAdd
object
Data for creating a new 'fullStackFeature' type change.
ExperienceChangeAdd
Data structure for adding a new change to an experience variation. The id field is omitted as it will be assigned upon creation.
GenericKey
object
1 property
RevenueGoal
BaseRuleWithNumericValue
ConcurrencyKey
string
A server-generated hash that represents the object's state at the time of retrieval. When included in an update request, the operation will only succeed if the…
AudienceExpandable
LocationTriggerDomElement
ExperienceChangeDefaultCodeDataUpdate
object
Data for updating an existing 'defaultCode' type change, identified by its id.
ExperienceChangeRichStructureDataAdd
object
Data for creating a new 'richStructure' type change.
LocationTrigger
Defines how and when an experience associated with this location should be activated for a visitor who matches the location's rules. The type determines the ac…
OsMatchRulesTypes
string
ExperienceTypes
string
The type of optimization activity: - a/b: Standard A/B test comparing an original page/element against one or more variations. Changes made via Visual Editor o…
ExperienceChangeCustomCodeDataAdd
object
Data for creating a new 'customCode' type change.
ExperienceIntegrationGA3
AudienceWithoutUrlMatching
TrackingScriptAvailableVersions
array
A list of available versions for the Convert tracking script, each with a version tag, changelog, release date, and potentially the date it was or will be appl…
IntegrationProvider
string
Identifies the third-party analytics, heatmap, or data platform with which Convert Experiences is integrated for this specific experience. This allows experime…
NumericMatchingOptions
string
BaseRuleWithDayOfWeekValue
ExperienceIntegrationYsance
ExperienceIntegrationBase
object
2 properties
1 required
LocationTriggerManual
ExperienceChange
Represents a single, specific modification applied as part of an experience's variation. The exact structure and content depend on the type of change.
ClicksElementGoalSettings
object
2 properties
1 required
IntegrationGA4Base
object
2 properties
ExperienceIntegrationEulerian
VisitorInsightsBase
object
3 properties
GenericBoolKeyValueMatchRulesTypes
string
BaseRule
object
1 property
1 required
Domain
object
A website domain data.
3 properties
ProjectIntegrationGA4
NumericOutlierBase
object
1 property
1 required
ExperienceIntegrationWoopra
ExperienceIntegrationCnzz
LocationRuleObject
object
Defines the logical structure for combining multiple rule conditions for a Location. It uses a nested OR - AND - ORWHEN structure, similar to Audience rules, b…
1 property
BaseRuleWithWeatherConditionValue
LocationBase
object
7 properties
NumericMatchRulesTypes
string
LanguageMatchRule
GoalStats
object
2 properties
SimpleAudience
object
2 properties
NumericOutlierTypes
string
The method used for detecting and handling order outliers in revenue or product count tracking: - none: No outlier detection is applied. - minmax: Orders with…
ClicksElementGoal
BoolMatchRulesTypes
string
ExperienceReportingSettings
object
Comprehensive settings governing how an experience's results are reported and analyzed.
18 properties
GoalBase
object
Base properties common to all types of conversion goals.
9 properties
VisitorDataExistsMatchRule
AudienceStatuses
string
The status of an audience: - active: The audience is currently active and can be used for targeting experiences. - archived: The audience is no longer active a…
ExperienceIntegrationBaidu
Experience
ExperienceChangeDefaultCodeMultipageData
object
Represents a 'defaultCodeMultipage' type change, including its system-assigned ID.
ExperienceChangeDefaultCodeMultipageDataBase
object
Defines a standard code-based change that applies to a specific page within a Multi-page Funnel experiment. This allows different code (CSS, JS) to be applied…
TrackingScriptRelease
GoalExpandable
GaGoal
BaseRuleWithLanguageCodeValue
Base64Image
object
1 property
LocationExpandable
ConvertibleExperienceTypes
string
GoalTriggeredMatchRule
RuleElementAudience
JsConditionMatchRule
ExperienceChangeUpdate
Data structure for updating an existing change within an experience variation. Requires the id of the change to be modified.
TrackingScriptReleaseBase
object
Base settings for managing how new versions of the Convert tracking script are applied to the project.
1 property
OsMatchRule
Goal
BaseRuleWithHourOfDayValue
DomInteractionGoal
ProjectIntegrationGA3
CountryMatchRule
NumericOutlierMinMax
ChoiceMatchingOptions
string
NoSettingsGoal
ExperienceIntegrationMixpanel
ExperienceVariationBase
object
6 properties
SE_ProcSettingsBase
object
1 property
TrackingScriptReleaseScheduled
Tag
object
Represents a tag (keyword or label) that can be associated with various Convert entities like experiences, goals, audiences, hypotheses, and observations. Tags…
3 properties
SE_ProcSettingsFrequentist
GenericNumericKeyValueMatchRulesTypes
string
AudienceBase
object
7 properties
ExperienceIntegrationGA4
ExperienceChangeDefaultCodeMultipageDataUpdate
object
Data for updating an existing 'defaultCodeMultipage' type change, identified by its id.
SubmitsFormGoalSettings
object
1 property
1 required
DNSRecordTypes
string
The type of the DNS record.
ExperienceIntegrationMicrosoftClarity
Configuration for Microsoft Clarity. When enabled, experiment context can be sent for segmentation in Clarity recordings and heatmaps. No provider-specific set…
ProjectExpandable
HourOfDayMatchRule
ExperienceChangeCustomCodeData
object
Represents a 'customCode' type change, including its system-assigned ID.
CookieMatchRule
ExperienceIntegrationHeapanalytics
LocationTriggerCallback
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Convert 12
Other APIs Convert publishes across the network.
Convert Experiences REST API v2
Convert Accounts API
Convert AI content API
Convert API Keys API
Convert Audiences API
Convert Bulk API
Convert Cdn Images API
Convert Collaborators API
Convert Cookie Authentication API
Convert Domains API
Convert Experience Sections API
Convert Experiences API
#Experience Variations
Where this information came from
This is an independent, third-party profile of Convert Experience Variations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.