{ "opencollection": "1.0.0", "info": { "name": "Convert Accounts Projects API", "version": "2.0.0" }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "List projects within an account", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a list of all projects belonging to the specified account that the authenticated user has access to.\nSupports filtering by project status, name/description search, and pagination.\nA project in Convert is a container for organizing experiences (A/B tests, personalizations), goals, audiences, and associated domains.\nAs per the Knowledge Base: \"Each project has its own tracking code, set of experiences, and set of collaborators.\"\n" }, { "info": { "name": "Get change history for a specific project", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/change-history", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project to be retrieved" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a historical log of changes made within a specific project.\nThis includes modifications to experiences, goals, audiences, locations, and project settings.\nProvides an audit trail for project-level activities, filterable by date, user, and event type.\nThe Knowledge Base states: \"Convert logs most actions that can be made in a Project; for example: creating an experiment, modifying a variation, adding and removing audiences, and more.\"\n" }, { "info": { "name": "Get details for a specific project", "type": "http" }, "http": { "method": "GET", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project to be retrieved" }, { "name": "include", "value": "", "type": "query", "description": "Specifies the list of fields to be included in the response, which otherwise would not be sent.\n\nRead more in the section related to [Optional Fields](#tag/Optional-Fields)\n" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.\n\nRead more in the section related to [Expanding Fields](#tag/Expandable-Fields)\n" } ] }, "docs": "Retrieves comprehensive details for a single project, identified by its `project_id`.\nThis includes its name, type (web or fullstack), global JavaScript, settings (like time zone, jQuery inclusion), integrations, and optionally, associated domains and usage statistics.\nThe `include` parameter can fetch related data like `domains` or `stats.usage`. The `expand` parameter can provide full objects for linked entities.\n" }, { "info": { "name": "Create a new project", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/add", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new project" }, { "info": { "name": "Update an existing project", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/update", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the settings of an existing project.\nThis can include changing its name, global JavaScript, time zone, active domains, integration settings, or GDPR compliance options.\nThe list of domains provided in the request will replace the existing list.\n" }, { "info": { "name": "Delete a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/delete", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project to be deleted" } ] }, "docs": "Permanently removes an existing project and all its associated data (experiences, goals, audiences, reports) from the specified account.\nThis action is irreversible.\nThe Knowledge Base warns: \"When a project is deleted all data will be purged from our servers within 7 days and is unrecoverable after that time.\"\n" }, { "info": { "name": "Get live tracking events for a specific project", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/livedata", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project for which live data is returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves the last 100 tracking events (e.g., experiment views, goal conversions) specifically for the given project.\nUseful for real-time monitoring of a single project's activity. Supports filtering by event types, experiences, and goals.\nAs per the Knowledge Base: \"Live Logs in Convert track how end users are interacting with web pages and experiments...at a project and experiment level in real time.\"\n" }, { "info": { "name": "Update multiple projects at once", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/bulk-update", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows for updating settings (like tracking script version) for multiple projects simultaneously within an account.\nRequires a list of project IDs and the settings to apply.\n" }, { "info": { "name": "Generate a debug token for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/generate-debug-token", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project" } ] }, "docs": "Creates a temporary debug token for a project. This token can be used with the Convert tracking script\n(e.g., via the `convert-debug-token` header or query parameter) to preview draft or paused experiences,\nor to force specific variations for QA purposes without affecting live experiment data.\nThe token has a limited time-to-live (TTL).\n" }, { "info": { "name": "Export project data as JSON", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/export", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account that owns the retrieved/saved data" }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a JSON file containing all configuration data for a specific project.\nThis includes its experiences, goals, audiences, locations, hypotheses, and project settings.\nUseful for backing up project configurations or migrating them to another Convert account or instance.\nThe Knowledge Base mentions this feature for \"Save and Migrate Project Settings\" and \"Template Creation\".\n" }, { "info": { "name": "Import project data from a JSON file", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/import-project", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account where the project will be stored." } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Creates a new project or updates an existing one by importing data from a JSON file (previously exported from Convert).\nThis allows for restoring backups or replicating project setups.\nThe Knowledge Base mentions this for \"Save and Migrate Project Settings\" and \"Template Creation\".\n" }, { "info": { "name": "Import associated data into an existing project", "type": "http" }, "http": { "method": "POST", "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/import-project-data", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "ID of the account where the project is stored." }, { "name": "project_id", "value": "", "type": "path", "description": "ID of the project to which details will be attached." } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Imports associated data (like experiences, goals, audiences) from a JSON file into an already existing project.\nThis is useful for selectively adding or updating components within a project from an export.\nThe Knowledge Base mentions \"Selective Import/Export: Choose to export/import entire projects or only selected goals, audiences, and locations.\"\n" } ] } ], "bundled": true }