The identity and technical contract details declared by the specification.
ProjectHistoryPersistentOptions
KnowledgeBasesListPersistentOptions
UserSessionEntry
object
6 properties
UserSessionRevokeRequestData
object
1 property
1 required
ExperienceHistoryObjects
string
ObservationsListFilteringOptions
ObservationStatuses
string
The current status of an observation in its lifecycle: - active: The observation is current, under consideration, or being actively discussed. This is the defa…
ChangeHistoryObjects
string
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…
ProjectHistoryColumnNames
string
Available columns for the project change history log in the UI.
UserLoginProviders
string
The identity provider used for user login: - convert: Standard username/password authentication managed by Convert. - google: Authentication via Google Sign-In…
SortDirection
object
1 property
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…
FeaturesListColumnNames
string
Available columns for the features list in the UI.
AccessRolesList
array
A list of access role objects, each detailing a role name and its associated permissions.
ExperienceReportSecondViewPersistentOptions
UserData
object
Detailed information about an authenticated user, including their profile, UI preferences, and security settings.
4 properties
KnowledgeBasesListColumnNames
string
Available columns for the Knowledge Base list in the UI.
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…
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…
OnlyCount
object
1 property
ExperienceHistoryPersistentOptions
ProjectsListPersistentOptions
TrackingScriptReleaseTypes
string
Defines the update strategy for the project's Convert tracking script: - manual: (Default) The project remains on its current script version. Updates to newer…
mfaDisableRequest
object
Request to disable Multi-Factor Authentication (MFA) for the user.
2 properties
LocationsListPersistentOptions
CommonBasicPermissions
object
4 properties
AccessRolesListResponseData
object
1 property
ProjectLiveDataColumnNames
string
Available columns for the project-level live data feed in the UI.
ExperienceReportSectionNames
string
Identifiers for the different collapsible/reorderable sections within the experience report UI.
ObservationsListColumnNames
string
Available columns for the observations list in the UI.
LiveDataExpandFields
string
ErrorData
object
3 properties
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…
ReportingSegmentsCampaign
string
The campaign name associated with the visitor's session, typically derived from utmcampaign URL parameters. Allows report segmentation by marketing campaign. K…
AccountLiveDataPersistentOptions
RolePermissions
object
18 properties
UserSessionRevokeResponseData
object
2 properties
2 required
ExperiencesListFilteringOptions
object
AudiencesListPersistentOptions
ExperienceLiveDataColumnNames
string
Available columns for the experience-level live data feed in the UI.
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…
AccountExperiencesListColumnNames
string
Available columns for the account-wide experiences list in the UI.
LocationsListColumnNames
string
Available columns for the locations list in the UI.
AccountExperiencesListPersistentOptions
UserSessionRevokeAllResponseData
object
2 properties
2 required
PageNumber
object
1 property
ChangeHistoryExpandFields
string
SuccessData
object
2 properties
ExperiencesListPersistentOptions
ConfirmEmailRequestData
object
Contains the confirmation code required to verify a new email address for a user account.
1 property
1 required
SdkKeysListPersistentOptions
object
1 property
AudiencesListFilteringOptions
KnowledgeBasesListFilteringOptions
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…
FeaturesListPersistentOptions
GoalsListFilteringOptions
GoalTypes
string
The type of user action or event that this goal tracks as a conversion. - advanced: A goal defined by a complex set of custom rules using the Advanced Goal Edi…
CompassColumnsNames
string
Available tabs for the compass list in the UI.
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…
ExperienceHistoryFilteringOptions
UserPreferences
object
A collection of user-specific settings that customize their experience within the Convert application UI. These preferences do not impact the execution or beha…
6 properties
UserSessionsListResponseData
object
1 property
1 required
TimeRange
object
3 properties
CompassColumnsPersistentOptions
object
1 property
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…
AccountHistoryPersistentOptions
HypothesesListFilteringOptions
SignalSessionsListColumnNames
string
Available columns for the Convert Signals™ sessions list in the UI.
ChangeHistoryExpandParameter
object
1 property
AccountHistoryFilteringOptions
KnowledgeBaseStatuses
string
The status of a Knowledge Base entry: - active: The entry is current and relevant. - archived: The entry is kept for historical purposes but may no longer be c…
ProjectLiveFilteringOptions
object
Filters for the live data feed of a single project.
4 properties
ProjectsListColumnNames
string
Available columns for the projects list in the UI.
ColumnPreference
object
Defines user preference for a single column in a UI list view (name and visibility).
2 properties
ExperienceReportFirstViewColumnNames
string
Available columns for the goals-by-variations view in the experience report UI.
HypothesesListPersistentOptions
ChangeHistoryMethods
string
AccountLiveDataColumnNames
string
Available columns for the account-level live data feed in the UI.
AccountHistoryColumnNames
string
Available columns for the account change history log in the UI.
AudiencesListColumnNames
string
Available columns for the audiences list in the UI.
UserMfaSecret
object
Contains the secret key required to set up Multi-Factor Authentication (MFA) with an authenticator app.
1 property
ReportingSegmentsDeviceCategories
string
The category of device used by the visitor. Enables report segmentation by device type. - iPhone, otherphones, allphones: Mobile phone categories. - desktop: D…
AccountExperiencesListFilteringOptions
object
SignalSessionsListFilteringOptions
ResultsPerPage
object
1 property
AccountLiveDataFilteringOptions
UserProfileDataUpdate
object
7 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…
AccessRole
object
2 properties
HypothesesListColumnNames
string
Available columns for the hypotheses list in the UI.
SignalSessionsListPersistentOptions
ExperienceLiveDataFilteringOptions
object
Filters for the live data feed of a single experience.
3 properties
GoalsListColumnNames
string
Available columns for the goals list in the UI.
LiveDataAutoRefreshSettings
object
1 property
ExperienceLiveDataPersistentOptions
LiveDataEventTypes
string
BaseUiSectionPreference
object
Defines user preference for a section in a UI view (name and visibility).
2 properties
GoalsListPersistentOptions
LocationsListFilteringOptions
mfaEnableRequest
object
Request to enable Multi-Factor Authentication (MFA) for the user.
3 properties
ExperienceReportSecondViewColumnNames
string
Available columns for the variations-by-goals view in the experience report UI.
ExperienceReportPersistentOptions
object
1 property
ProjectsListFilteringOptions
ExperiencesListColumnNames
string
Available columns for the experiences list in the UI.
ObservationsListPersistentOptions
SdkKeysListColumnNames
string
Available columns for the sdk keys list in the UI.
FeaturesListFilteringOptions
ChangeHistoryObjectTypes
string
ExperienceReportFirstViewPersistentOptions
ProjectLiveDataPersistentOptions
ProjectHistoryFilteringOptions
LiveDataExpandParameter
object
1 property
HypothesisStatuses
string
The current stage or outcome of a hypothesis in its lifecycle: - draft: The hypothesis is still being formulated or refined; not yet ready for testing. - compl…
ExperienceHistoryColumnNames
string
Available columns for the experience change history log in the UI.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Convert publishes across the network.
