The identity and technical contract details declared by the specification.
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
ExperienceChangeDefaultRedirectData
object
Represents a 'defaultRedirect' type change, including its system-assigned ID.
TrackingScriptReleaseLatest
ExperiencesList
array
A list of experience objects.
ExperienceIntegrationClicky
ExperienceChangeDefaultRedirectDataAdd
object
Data for creating a new 'defaultRedirect' type change.
SortDirection
object
1 property
GA_SettingsBase
object
1 property
CustomDomainOwnershipVerificationItem
object
3 properties
ScrollPercentageGoalSettings
object
1 property
1 required
ExperienceIntegrationEconda
GetExperienceLiveDataRequestData
VisualEditorUserAgents
string
Predefined User-Agent strings that the Visual Editor can emulate for responsive design and device-specific testing.
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
MultipageExperiencePage
Defines a single page within a 'multipage' (funnel) experience.
CloneExperienceRequestData
object
Parameters for cloning an experience.
1 property
ExperienceIntegrationGA4Base
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…
BulkExperienceStatuses
string
HourOfDayMatchRulesTypes
string
BaseRuleWithGoalTriggeredValue
TrackingScriptReleaseManual
ExperienceChangeIdReadOnly
object
Represents the unique identifier of a change, typically when returned by the API after creation or in a list.
1 property
ExperienceChangeDefaultRedirectDataUpdate
object
Data for updating an existing 'defaultRedirect' type change, identified by its id.
ExperienceVariationCreate
ExperienceIntegrationMouseflow
SimpleGoal
object
2 properties
ExperienceIncludeFields
string
BulkExperienceIds
array
A list of unique numerical identifiers for experiences to be affected by a bulk operation.
GetExperiencesListRequestData
ExperienceChangeDefaultCodeDataUpdate
object
Data for updating an existing 'defaultCode' type change, identified by its id.
ExperienceChangeRichStructureDataAdd
object
Data for creating a new 'richStructure' type change.
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.
ExperienceIntegrationBase
object
2 properties
1 required
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.
SimpleAudienceSegmentExpandable
GenericBoolKeyValueMatchRulesTypes
string
NumericOutlierBase
object
1 property
1 required
ExperienceIntegrationWoopra
NumericMatchRulesTypes
string
SimpleAudience
object
2 properties
GetExperienceHistoryRequestData
BoolMatchRulesTypes
string
BulkEntityError
object
2 properties
ExperienceCreateUpdateAudiences
array
A list of Audience IDs to associate with the experience. Visitors must match criteria from these audiences (according to settings.matchingoptions.audiences) to…
SE_ProcSettingsBase
object
1 property
SE_ProcSettingsFrequentist
ExperienceIntegrationMicrosoftClarity
Configuration for Microsoft Clarity. When enabled, experiment context can be sent for segmentation in Clarity recordings and heatmaps. No provider-specific set…
TagExpandableRequest
Represents a tag when associating it with another entity (like an experience or goal) during a create or update operation. Can be either the existing integer I…
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
IntegrationGA3
object
2 properties
WeatherConditionMatchRulesTypes
string
ExperienceVariationBaseExtended
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…
TextMatchingOptions
string
MinuteOfHourMatchRulesTypes
string
BaseProject
object
12 properties
TextMatchRulesTypes
string
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
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
GenericNumericKeyValueMatchRule
ReportingSegmentsBrowser
string
The web browser used by the visitor. Used for segmenting reports to understand how experiences perform across different browsers. Knowledge Base: "Using Basic…
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…
ExperienceChangeRichStructureDataUpdate
object
Data for updating an existing 'richStructure' type change, identified by its id.
CreateExperienceRequestData
Request body for creating a new experience. Requires at least name, status, type, and url. Other fields like variations, audiences, goals, and settings are hig…
4 required
GenerateDebugTokenData
object
2 properties
ExperienceChangeRichStructureData
object
Represents a 'richStructure' type change, including its system-assigned ID.
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
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
CountryMatchRulesTypes
string
WeatherConditionMatchRule
ExperienceChangeFullStackFeature
object
Represents a 'fullStackFeature' type change, including its system-assigned ID.
ExperienceAlert
object
3 properties
BaseRuleWithCountryCodeValue
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…
ExperienceIntegrationEulerian
LocationTriggerBase
object
1 property
1 required
ChangeHistory
object
Represents a single logged change event, providing an audit trail for actions performed on Convert entities.
11 properties
SuccessData
object
2 properties
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
BrowserNameMatchRulesTypes
string
ReportingSegmentsCountry
string
The two-letter ISO 3166-1 alpha-2 country code of the visitor, determined by IP geolocation. Used for segmenting reports by country to analyze geographical per…
GaGoalSettings
object
1 property
ExperienceIntegrationClicktale
ExperienceChangeFullStackFeatureAdd
object
Data for creating a new 'fullStackFeature' type change.
GenericKey
object
1 property
ReportingSegmentsVisitorType
string
Classifies the visitor as either 'new' or 'returning' based on their site visit history (tracked by Convert cookies). - new: First-time visitor to the site (or…
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…
BulkDeleteExperiencesRequestData
object
Request body for bulk deleting multiple experiences. Contains a list of experience IDs to be permanently removed.
1 property
1 required
ExperienceIntegrationYsance
NumericMatchingOptions
string
ClicksElementGoalSettings
object
2 properties
1 required
VisitorInsightsBase
object
3 properties
ChangeHistoryMethods
string
ExperienceIntegrationCnzz
BaseRuleWithWeatherConditionValue
LocationBase
object
7 properties
GoalStats
object
2 properties
GoalBase
object
Base properties common to all types of conversion goals.
9 properties
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…
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…
BaseRuleWithLanguageCodeValue
ExperienceVariationBase
object
6 properties
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
ExperienceReportToken
object
3 properties
LiveDataExpandParameter
object
1 property
ExperienceChangeDefaultCodeMultipageDataUpdate
object
Data for updating an existing 'defaultCodeMultipage' type change, identified by its id.
DNSRecordTypes
string
The type of the DNS record.
SE_ProcTypes
string
The statistical methodology used for analyzing experiment results and determining winners. - frequentist: Traditional hypothesis testing approach using p-value…
BaseRuleWithBrowserNameValue
ExperienceHistoryObjects
string
BaseRuleWithSegmentBucketedValue
GenericTextKeyValueMatchRule
ExperienceChangeFullStackFeatureUpdate
object
Data for updating an existing 'fullStackFeature' type change, identified by its id.
ExperienceIntegrationGoogleAnalytics
TagExpandable
Represents a tag, either as its unique ID or as the full tag object (ID, name, description) if expanded.
TriggerExperienceScreenshotsRequestData
object
Parameters for triggering screenshot generation for an experience's variations.
2 properties
ReportingSegmentsCustomSegment
integer
The numerical ID of a custom Convert Audience (of type 'segmentation') that the visitor is a member of. Allows report segmentation based on predefined custom s…
SimpleExperienceFlat
object
2 properties
BaseRuleWithMinuteOfHourValue
BulkUpdateExperiencesRequestData
object
Request body for bulk updating the status of multiple experiences.
2 properties
2 required
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…
ChangeHistoryList
array
A list of change history records.
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.
ExperienceIntegrationCrazyegg
Configuration for integrating with Crazy Egg. Convert sends experiment and variation data to allow segmentation of Crazy Egg heatmaps and recordings by variati…
ReportingSegmentsFilters
object
A collection of filters used to segment experience report data based on various visitor attributes and traffic sources. Applying these filters allows for deepe…
7 properties
ReportingSegmentsSource
string
The traffic source that brought the visitor to the site (e.g., 'google', 'facebook.com', 'direct', 'newsletter'). Derived from utmsource URL parameters or the…
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
DayOfWeekMatchRulesTypes
string
JsConditionMatchRulesTypes
string
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…
ExperienceChangeDefaultCodeDataAdd
object
Data for creating a new 'defaultCode' type change.
LiveDataExpandFields
string
ErrorData
object
3 properties
ExperienceBase
object
20 properties
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…
ExperienceVariationUpdate
ExperienceChangeFullStackFeatureBase
object
Defines a change for a Full Stack experiment that involves enabling or configuring a specific 'Feature' and its variables for this variation.
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
GoalTriggeredMatchRulesTypes
string
PageNumber
object
1 property
ExperienceChangeRichStructureDataBase
object
Defines a complex change, often involving multiple DOM manipulations or structured data, typically generated by advanced Visual Editor interactions or specific…
ChangeHistoryListResponseData
object
2 properties
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…
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…
BaseRuleWithDayOfWeekValue
ChangeHistoryExpandParameter
object
1 property
ExperienceExpandFields
string
SimpleExperienceExpandable
Represents an experience in a simplified form, either as its ID and a variation context, or including its name.
SimpleAudienceSegment
object
2 properties
ExperienceCreateUpdateStatuses
string
The set of statuses a caller may set when creating or updating an experience.
ReportingSegmentsDeviceCategories
string
The category of device used by the visitor. Enables report segmentation by device type. - iPhone, otherphones, allphones: Mobile phone categories. - desktop: D…
ResultsPerPage
object
1 property
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…
ExperienceReportingSettings
object
Comprehensive settings governing how an experience's results are reported and analyzed.
18 properties
VisitorDataExistsMatchRule
ExperienceCreateUpdateGoals
array
A list of Goal IDs to attach to the experience for conversion tracking. The first goal in this list is often implicitly considered the primarygoal unless expli…
ExperienceIntegrationBaidu
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
ChoiceMatchingOptions
string
SimpleExperienceVariationExpandable
TrackingScriptReleaseScheduled
AudienceBase
object
7 properties
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.
Pagination
object
4 properties
LiveDataEventsListResponseData
object
Response containing a list of recent live tracking events for a project or account.
1 property
SimpleLocation
object
2 properties
UpdateExperienceRequestData
Request body for updating an existing experience. Provide only the fields that need to be changed. The variations, audiences, locations, goals, tags, and multi…
LiveDataEvent
object
Represents a single real-time tracking event, such as a visitor being exposed to an experience or triggering a conversion goal.
12 properties
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…
GenericBoolKeyValueMatchRule
CollapsedExperienceVariationData
OnlyCount
object
1 property
ExperiencesListResponseData
object
Response containing a list of experiences within a project, along with pagination details if applicable.
2 properties
LiveDataEventsList
array
A list of live data event objects, showing real-time interactions.
LanguageMatchRulesTypes
string
ExperienceChangeDefaultCodeData
object
Represents a 'defaultCode' type change, including its system-assigned ID.
VisitorDataExistsMatchRulesTypes
string
RevenueGoalSettings
object
1 property
1 required
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
ReportingSegmentsCampaign
string
The campaign name associated with the visitor's session, typically derived from utmcampaign URL parameters. Allows report segmentation by marketing campaign. K…
ExperiencesListFilteringOptions
object
ExperienceIntegrationSitecatalyst
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
ExperienceChangeCustomCodeDataUpdate
object
Data for updating an existing 'customCode' type change, identified by its id.
DomInteractionGoalSettings
object
1 property
1 required
ExperienceIntegrationPiwik
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…
ExperienceIntegrationSegmentio
ExperienceIntegrationGosquared
ChangeHistoryExpandFields
string
ExperienceCreateUpdateLocations
array
A list of Location IDs to associate with the experience. The experience will run on pages/conditions defined by these locations (according to settings.matching…
ClicksLinkGoalSettings
object
1 property
1 required
ExperienceCollaborator
object
5 properties
SegmentBucketedMatchRulesTypes
string
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…
ExperienceChangeAdd
Data structure for adding a new change to an experience variation. The id field is omitted as it will be assigned upon creation.
ExperienceReportTokenRequestData
object
2 properties
ExperienceHistoryFilteringOptions
LocationTriggerDomElement
ExperienceCreateUpdatePages
object
1 property
AudienceWithoutUrlMatching
IntegrationProvider
string
Identifies the third-party analytics, heatmap, or data platform with which Convert Experiences is integrated for this specific experience. This allows experime…
IntegrationGA4Base
object
2 properties
BaseRule
object
1 property
1 required
Domain
object
A website domain data.
3 properties
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
SimpleProject
object
4 properties
ExperienceLiveDataFilteringOptions
object
Filters for the live data feed of a single experience.
3 properties
LiveDataEventTypes
string
BaseRuleWithHourOfDayValue
ExperienceIntegrationMixpanel
GenericNumericKeyValueMatchRulesTypes
string
SubmitsFormGoalSettings
object
1 property
1 required
SimpleExperienceVariation
object
2 properties
ExperienceChangeCustomCodeData
object
Represents a 'customCode' type change, including its system-assigned ID.
ExperienceIntegrationHeapanalytics
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Convert publishes across the network.