How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Convert

Convert Projects API

Once you start using Convert Experiences, you will have a growing number of experiences to manage. Projects help you keep everything organized across multiple sites. Each project has its own tracking code, set of experiences, and set of collaborators. For example, if you run experiences on multiple domains, you can assign a unique project for each domain. Read here some things you need to know about how a project behaves.

Documentation Provider Profile APIs.io OpenAPI GitHub

Convert Projects API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 12 paths, and defines 113 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 12 paths 113 schemas 1 DELETE2 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.convert.com/api/v2
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Convert Projects 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 12 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Projects 12

Once you start using Convert Experiences, you will have a growing number of experiences to manage. Projects help you keep everything organized across multiple sites. Each project…

POST
/accounts/{account_id}/projects
List projects within an account
getProjectsList 1 param body → 200default
POST
/accounts/{account_id}/projects/{project_id}/change-history
Get change history for a specific project
getProjectHistory 2 params body → 200default
GET
/accounts/{account_id}/projects/{project_id}
Get details for a specific project
getProject 4 params → 200default
POST
/accounts/{account_id}/projects/add
Create a new project
createProject 1 param body → 201default
POST
/accounts/{account_id}/projects/{project_id}/update
Update an existing project
updateProject 2 params body → 201default
DELETE
/accounts/{account_id}/projects/{project_id}/delete
Delete a project
deleteProject 2 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/livedata
Get live tracking events for a specific project
getProjectLiveData 2 params body → 200default
POST
/accounts/{account_id}/projects/bulk-update
Update multiple projects at once
bulkUpdateProjects 1 param body → 200default
GET
/accounts/{account_id}/projects/{project_id}/generate-debug-token
Generate a debug token for a project
generateDebugToken 2 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/export
Export project data as JSON
exportProject 2 params body → 201default
POST
/accounts/{account_id}/projects/import-project
Import project data from a JSON file
importProject 1 param body → 201default
POST
/accounts/{account_id}/projects/{project_id}/import-project-data
Import associated data into an existing project
importProjectData 2 params body → 201default

Schemas 113

The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are ExperienceReportingSettings (18 properties), BaseProject (12 properties), LiveDataEvent (12 properties), ChangeHistory (11 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…
Pagination
object
4 properties
ChangeHistoryObjects
string
DomainToCreate
1 required
IntegrationGA3
object
2 properties
LiveDataEventsListResponseData
object
Response containing a list of recent live tracking events for a project or account.
1 property
TrackingScriptReleaseLatest
SimpleLocation
object
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…
BulkProjectIds
array
A list of project unique numerical identifiers to be affected by a bulk operation.
SimpleExperienceFlat
object
2 properties
ImportProjectRequestData
BaseProject
object
12 properties
SortDirection
object
1 property
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
ChangeHistoryList
array
A list of change history records.
Project
Represents a Convert project, which is a container for organizing a set of related optimization activities (experiences), their goals, target audiences, associ…
SimpleProjectExpandable
GA_SettingsBase
object
1 property
NumericOutlier
CustomDomainOwnershipVerificationItem
object
3 properties
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
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…
LiveDataEventsList
array
A list of live data event objects, showing real-time interactions.
DomainExpandableRequest
Domain object sent inside request when creating/updating other related objects
NumericOutlierPercentile
VisualEditorUserAgents
string
Predefined User-Agent strings that the Visual Editor can emulate for responsive design and device-specific testing.
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…
GeneratedDebugTokenDataResponse
object
1 property
GenerateDebugTokenData
object
2 properties
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…
LiveDataExpandFields
string
ProjectExpandFields
string
SE_ProcSettingsBayesian
ErrorData
object
3 properties
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…
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…
SimpleAudienceExpandable
ProjectsRequestIncludeExpand
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…
UpdateProjectRequestData
TrackingScriptReleaseManual
SimpleLocationExpandable
GA_Settings
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
NumericOutlierNone
Extra
object
1 property
ChangeHistory
object
Represents a single logged change event, providing an audit trail for actions performed on Convert entities.
11 properties
SimpleGoal
object
2 properties
PageNumber
object
1 property
ProjectsListExpandFields
ChangeHistoryExpandFields
string
SuccessData
object
2 properties
ProjectHistoryRequestData
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
IntegrationGA4
ChangeHistoryListResponseData
object
2 properties
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…
ProjectGASettingsBase
SimpleGoalExpandable
ProjectsList
array
A list of project objects.
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…
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…
BulkSuccessData
ExportProjectRequestData
object
6 properties
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…
ChangeHistoryExpandParameter
object
1 property
ProjectLiveFilteringOptions
object
Filters for the live data feed of a single project.
4 properties
SimpleExperienceExpandable
Represents an experience in a simplified form, either as its ID and a variation context, or including its name.
SimpleAudienceSegmentExpandable
IntegrationGA4Base
object
2 properties
VisitorInsightsBase
object
3 properties
CreateProjectRequestData
Domain
object
A website domain data.
3 properties
ChangeHistoryMethods
string
ProjectIntegrationGA4
SimpleAudienceSegment
object
2 properties
GetProjectLiveDataRequestData
NumericOutlierBase
object
1 property 1 required
ProjectIncludeFields
string
BulkUpdateProjectsRequestData
object
Request body for bulk updating settings (like tracking script version) for multiple projects.
2 properties 1 required
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
ProjectsListIncludeField
GetProjectsListRequestData
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…
SimpleExperience
ExperienceReportingSettings
object
Comprehensive settings governing how an experience's results are reported and analyzed.
18 properties
SimpleProject
object
4 properties
BulkEntityError
object
2 properties
TrackingScriptRelease
LiveDataEventTypes
string
ProjectsListResponseData
object
Response containing a list of projects accessible to the user, along with pagination details if applicable.
2 properties
ProjectsExportResponseFile
object
Represents the structure of the JSON file exported for a project, containing all its configurations (experiences, goals, audiences, etc.).
TrackingScriptReleaseBase
object
Base settings for managing how new versions of the Convert tracking script are applied to the project.
1 property
ProjectIntegrationGA3
ProjectsListFilteringOptions
NumericOutlierMinMax
SimpleExperienceVariationExpandable
ProjectHistoryFilteringOptions
SE_ProcSettingsBase
object
1 property
TrackingScriptReleaseScheduled
LiveDataExpandParameter
object
1 property
SE_ProcSettingsFrequentist
ProjectExportObject
object
Defines filtering for a specific type of entity (e.g., experiences, goals) within a project export. Allows either an include list (only these IDs) or an exclud…
2 properties
DNSRecordTypes
string
The type of the DNS record.
SimpleExperienceVariation
object
2 properties
ImportProjectDataSuccess
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convert-projects-api-openapi.yml Raw ↑

Other APIs Convert publishes across the network.

Convert Experiences REST API v2
AE Profile APIs.io
Convert Accounts API
AE Profile APIs.io
Convert AI content API
AE Profile APIs.io
Convert API Keys API
AE Profile APIs.io
Convert Audiences API
AE Profile APIs.io
Convert Bulk API
AE Profile APIs.io
Convert Cdn Images API
AE Profile APIs.io
Convert Collaborators API
AE Profile APIs.io
Convert Cookie Authentication API
AE Profile APIs.io
Convert Domains API
AE Profile APIs.io
Convert Experience Sections API
AE Profile APIs.io
Convert Experience Variations API
AE Profile APIs.io
#Project
← Back to C APIs
API Details
ID
convert:convert-projects-api
Base URL
https://api.convert.com/api/v2
Docs
https://api.convert.com/doc/v2/
Provider
Convert
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=convert-projects-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/convert-projects-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Convert Projects 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.