Convert Accounts API
Account is the entity that contains all data. An account is owned by an user and in which more other users can have different permissions, account wide or at project level
Convert Accounts API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 12 operations across 11 paths, and defines 321 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.
12 operations
11 paths
321 schemas
5 GET7 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Convert Accounts 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 12
Across 11 paths, the API surfaces 12 operations — 5 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.
Accounts 12
Account is the entity that contains all data. An account is owned by an user and in which more other users can have different permissions, account wide or at project level
GET
/accounts
List accounts accessible to the user
GET
/billing-plans
List available billing plans
POST
/accounts/{account_id}/livedata
Get live tracking events for an account
POST
/accounts/{account_id}/change-history
Get change history for an account
POST
/accounts/{account_id}/experiences
List active and completed experiences for an account
GET
/accounts/{account_id}/details
Get details for a specific account
POST
/accounts/{account_id}/details
Update details for a specific account
POST
/accounts/{account_id}/sub-accounts/add
Create a new sub-account
POST
/accounts/{account_id}/addons
Request add-ons for an account
POST
/accounts/{account_id}/payment-setup
Initiate payment method setup
GET
/accounts/{account_id}/billing-portal
Get billing portal URL
GET
/accounts/{account_id}/plan_setup/users
Get users for billing plan setup notification
Schemas 321
The contract defines 321 schemas that model the data the API accepts and returns. The most detailed are ExperienceBase (20 properties), ExperienceReportingSettings (18 properties), BaseProject (12 properties), LiveDataEvent (12 properties). Each schema is shown below with its type and property counts.
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…
DayOfWeekMatchRule
ExperienceChangeDefaultRedirectData
object
Represents a 'defaultRedirect' type change, including its system-assigned ID.
TrackingScriptReleaseLatest
ExperiencesList
array
A list of experience objects.
ExperienceIntegrationClicky
SubAccountProductsCreate
object
1 property
SortDirection
object
1 property
AccountDetails
GA_SettingsBase
object
1 property
PaymentMethodPaypal
object
PayPal payment method data
2 properties
2 required
NumericOutlier
CustomDomainOwnershipVerificationItem
object
3 properties
ScrollPercentageGoalSettings
object
1 property
1 required
ExperienceIntegrationEconda
Products
string
The Convert product line this billing plan pertains to. - experiences: Relates to A/B testing, MVT, Split URL, and personalization features. - deploy: Relates…
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
SubAccountBillingPlanLimitsAndCapabilities
MultipageExperiencePage
Defines a single page within a 'multipage' (funnel) experience.
ExperienceIntegrationGA4Base
ExperienceSettings
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…
AccountsListResponseData
object
Response containing a list of accounts accessible to the authenticated user. For paginated results, refer to specific endpoint documentation if applicable.
1 property
HourOfDayMatchRulesTypes
string
BaseRuleWithGoalTriggeredValue
BillingPlanLimitsAndCapabilitiesBase
object
2 properties
TrackingScriptReleaseManual
ClicksLinkGoal
ExperienceChangeIdReadOnly
object
Represents the unique identifier of a change, typically when returned by the API after creation or in a list.
1 property
Account
ExperienceIntegrationMouseflow
SimpleGoal
object
2 properties
PaymentMethodInvoice
object
Invoice payment method data
2 properties
2 required
ExperienceIncludeFields
string
SubAccountCreate
LocationTriggerUponRun
MainAccountDetails
SubAccountDetailsBase
BaseRuleWithNumericValue
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…
ExperienceIntegrationBase
object
2 properties
1 required
BillingPlanLimitsAndCapabilities
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
PaymentMethod
object
Payment method information for billing purposes (used for both GET and UPDATE operations)
ExperienceIntegrationWoopra
AccountLiveDataRequestData
NumericMatchRulesTypes
string
SimpleAudience
object
2 properties
BoolMatchRulesTypes
string
GoalExpandable
GaGoal
LocationExpandable
DomInteractionGoal
ChangeHistoryObjectTypes
string
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…
CookieMatchRule
LocationTriggerCallback
AccountDetailsResponseData
object
Contains the full details of a requested account, which could be a main account or a sub-account.
1 property
AccountHistoryRequestData
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
WeatherConditionMatchRulesTypes
string
IntegrationGA3
object
2 properties
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
SubAccountDetails
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
BaseRuleWithOsValue
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…
VisitorTypeMatchRule
PaymentMethodVoucher
object
Voucher payment method data
2 properties
2 required
RuleElement
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
RuleElementNoUrl
Location
SE_ProcSettingsBayesian
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.
PlanSetupUsersResponseData
object
A list of users associated with an account, intended for notification during billing plan setup or changes.
1 property
AdvancedGoal
SimpleLocationExpandable
SubAccountProducts
object
1 property
SubAccountStats
object
1 property
ExperienceAlert
object
3 properties
BaseRuleWithCountryCodeValue
BrowserNameMatchRule
AudienceWithUrlMatching
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
NumericOutlierNone
ChangeHistory
object
Represents a single logged change event, providing an audit trail for actions performed on Convert entities.
11 properties
LocationTriggerBase
object
1 property
1 required
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…
BaseRuleWithBooleanValue
GaGoalSettings
object
1 property
MinuteOfHourMatchRule
ExperienceIntegrationClicktale
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…
GenericKey
object
1 property
RevenueGoal
AccountsList
array
List of accounts
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…
BillingPortalResponseData
object
Wrapper object for the billing portal response.
1 property
AudienceExpandable
BillingPlanBillByEnum
string
Indicates the primary metric used for billing and quota calculation for the plan: - testedUsers: Billing is based on the number of unique identified users part…
MainAccount
Represents a main Convert account, which can own projects and sub-accounts, and manages its own billing.
ExperienceIntegrationYsance
NumericMatchingOptions
string
AccountHistoryFilteringOptions
ClicksElementGoalSettings
object
2 properties
1 required
VisitorInsightsBase
object
3 properties
BillingUsageLimit
ChangeHistoryMethods
string
ProjectIntegrationGA4
ExperienceIntegrationCnzz
AccountLiveDataFilteringOptions
BaseRuleWithWeatherConditionValue
LocationBase
object
7 properties
GoalStats
object
2 properties
MainAccountDetailsUpdate
SimpleExperience
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…
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
BaseRuleWithLanguageCodeValue
GoalTriggeredMatchRule
RuleElementAudience
ProjectIntegrationGA3
NoSettingsGoal
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
LiveDataExpandParameter
object
1 property
DNSRecordTypes
string
The type of the DNS record.
ProjectExpandable
StartPaymentSetupRequestData
object
Options that could be used for initiating payment setup. Currently only the billing plans can be passed.
1 property
SE_ProcTypes
string
The statistical methodology used for analyzing experiment results and determining winners. - frequentist: Traditional hypothesis testing approach using p-value…
BaseRuleWithBrowserNameValue
BaseRuleWithSegmentBucketedValue
GenericTextKeyValueMatchRule
ExperienceIntegrationGoogleAnalytics
TagExpandable
Represents a tag, either as its unique ID or as the full tag object (ID, name, description) if expanded.
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
ChangeHistoryList
array
A list of change history records.
ExperienceVariation
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…
SimpleProjectExpandable
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.
AccountTypes
string
Defines the type of the account: - main: A primary account that can have sub-accounts and manages its own billing. - sub: A secondary account existing under a…
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…
StartPaymentSetupStripeResponseData
object
Stripe payment setup response.
2 properties
2 required
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
BillingPortal
object
Authenticated Paddle billing portal URL for the given account.
1 property
JsConditionMatchRulesTypes
string
StartPaymentSetupResponseData
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…
SubAccountDetailsUpdate
LiveDataExpandFields
string
BillingUsageLimitBase
object
1 property
ErrorData
object
3 properties
PaymentMethodWireTransfer
object
Wire transfer payment method data
2 properties
2 required
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…
GA_Settings
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
SubmitsFormGoal
Extra
object
1 property
GoalTriggeredMatchRulesTypes
string
PageNumber
object
1 property
SegmentBucketedMatchRule
ExperienceChangeRichStructureDataBase
object
Defines a complex change, often involving multiple DOM manipulations or structured data, typically generated by advanced Visual Editor interactions or specific…
IntegrationGA4
ChangeHistoryListResponseData
object
2 properties
SimpleGoalExpandable
ScrollPercentageGoal
StartPaymentSetupPaddleResponseData
object
Paddle payment setup response.
2 properties
2 required
AccountDetailsUpdate
AccountGeneralStats
object
General usage statistics for the account, typically for the current billing period. This is an optional field in API responses, included via include[]=stats.
6 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
PlanUpdateBody
object
1 property
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.
PaymentMethodCard
object
Credit/debit card payment method data (used for both GET and UPDATE operations)
2 properties
2 required
AccountDetailsIncludeFields
string
SimpleAudienceSegment
object
2 properties
MainAccountStats
object
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…
MainAccountBase
ResultsPerPage
object
1 property
SubAccountBillingPlanData
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
ExperienceIntegrationBaidu
JsConditionMatchRule
TrackingScriptReleaseBase
object
Base settings for managing how new versions of the Convert tracking script are applied to the project.
1 property
OsMatchRule
Goal
SimpleExperienceVariationExpandable
ChoiceMatchingOptions
string
TrackingScriptReleaseScheduled
AudienceBase
object
7 properties
HourOfDayMatchRule
BillingPlanData
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.
AccountAddonsTypes
string
BillingPlansListResponseData
object
Contains a list of all active billing plans that an account can subscribe to.
1 property
MainAccountDetailsBase
Pagination
object
4 properties
GenericBoolMatchRule
LiveDataEventsListResponseData
object
Response containing a list of recent live tracking events for a project or account.
1 property
SimpleLocation
object
2 properties
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
RequestAccountAddonsData
object
Specifies the add-on to request and optionally, collaborator details if it's for a specific user.
3 properties
1 required
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
BaseRuleWithStringValue
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.
NumericOutlierPercentile
LanguageMatchRulesTypes
string
ExperienceChangeDefaultCodeData
object
Represents a 'defaultCode' type change, including its system-assigned ID.
GenericTextMatchRule
GenericNumericMatchRule
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
SimpleAudienceExpandable
AddonPlanUpdateBody
object
2 properties
ReportingSegmentsCampaign
string
The campaign name associated with the visitor's session, typically derived from utmcampaign URL parameters. Allows report segmentation by marketing campaign. K…
ExperienceIntegrationSitecatalyst
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
Audience
DomInteractionGoalSettings
object
1 property
1 required
ExperienceIntegrationPiwik
BillingPlanDataBase
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
BaseRuleWithJsCodeValue
ChangeHistoryExpandFields
string
LocationRuleElement
PlanStatus
string
Account billing status
ProjectGASettingsBase
AccountExperiencesListRequestData
ExperienceCollaborator
object
5 properties
SegmentBucketedMatchRulesTypes
string
ClicksLinkGoalSettings
object
1 property
1 required
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…
SubAccountBase
object
Base properties common to both main and sub-accounts.
5 properties
LocationTriggerDomElement
SubAccount
Represents a sub-account, typically managed under a main (often agency) account. It has its own projects but its usage quotas are often derived from the parent…
PaymentMethodApplePay
object
Apple Pay payment method data
2 properties
2 required
ExperienceIntegrationGA3
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…
LocationTriggerManual
IntegrationGA4Base
object
2 properties
BaseRule
object
1 property
1 required
Domain
object
A website domain data.
3 properties
AccountExperiencesListFilteringOptions
object
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
AccountProducts
object
1 property
LanguageMatchRule
ClicksElementGoal
SimpleProject
object
4 properties
LiveDataEventTypes
string
BaseRuleWithHourOfDayValue
CountryMatchRule
NumericOutlierMinMax
ExperienceIntegrationMixpanel
GenericNumericKeyValueMatchRulesTypes
string
ExperienceIntegrationGA4
SubmitsFormGoalSettings
object
1 property
1 required
SimpleExperienceVariation
object
2 properties
ExperienceChangeCustomCodeData
object
Represents a 'customCode' type change, including its system-assigned ID.
ExperienceIntegrationHeapanalytics
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 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 Experience Variations API
Convert Experiences API
#Account
Where this information came from
This is an independent, third-party profile of Convert Accounts 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.