Jump to Content

Export project data as JSON

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/export

Generates a JSON file containing all configuration data for a specific project. This includes its experiences, goals, audiences, locations, hypotheses, and project settings. Useful for backing up project configurations or migrating them to another Convert account or instance. The Knowledge Base mentions this feature for "Save and Migrate Project Settings" and "Template Creation".

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project

Body Params

Specifies which components of the project to include in the JSON export. You can choose to include/exclude the main project settings, and lists of specific experiences, audiences, locations, goals, or hypotheses by their IDs. Useful for backups or migrations.

includeProject

boolean

Defaults to true

If true (default), includes the main project settings and configurations in the export. If false, only selected sub-entities (experiences, goals, etc.) might be exported.

experiences

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 exclude list (all IDs except these). If both are omitted, all items of that entity type are included.

audiences

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 exclude list (all IDs except these). If both are omitted, all items of that entity type are included.

locations

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 exclude list (all IDs except these). If both are omitted, all items of that entity type are included.

goals

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 exclude list (all IDs except these). If both are omitted, all items of that entity type are included.

hypothesis

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 exclude list (all IDs except these). If both are omitted, all items of that entity type are included.

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

download/json

application/json