Configuring Convert as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Convert option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need your Convert API credentials for this connection.- Key ID: Your API Key ID.
- Key Secret: Your API Key Secret.
- Account ID: The ID of the account to sync.
- Project ID: The ID of the project to sync.
2. Select streams
Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can determine when to execute a full sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. Once you are ready, click Next to finalize the setup.5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.For you to be able to see it on your Catalog, you need at least one successful source run.
Streams and Fields
Below you’ll find all available data streams from Convert and their corresponding fields:Experience List
Experience List
Stream for fetching a list of experiences.
| Field | Type | Description |
|---|---|---|
id | Integer | The unique identifier for the experience. |
name | String | The name of the experience. |
description | String | The description of the experience. |
objective | String | The objective of the experience. |
type | String | The type of the experience. |
status | String | The status of the experience. |
start_time | Integer | The start time of the experience. |
end_time | Integer | The end time of the experience. |
global_js | String | The global JavaScript for the experience. |
global_css | String | The global CSS for the experience. |
url | String | The URL of the experience. |
environment | String | The environment of the experience. |
project | Integer | The project ID associated with the experience. |
primary_goal | Integer | The primary goal ID for the experience. |
traffic_distribution | Number | The traffic distribution for the experience. |
settings | Object | The settings for the experience. |
version | Integer | The version of the experience. |
integrations | Array of Objects | The integrations for the experience. |
key | String | The key for the experience. |
screenshots_info | Array of Objects | Information about screenshots for the experience. |
site_area | String | The site area for the experience. |
concurrency_key | String | The concurrency key for the experience. |
Experience Details
Experience Details
Stream for fetching experience details.
| Field | Type | Description |
|---|---|---|
id | Integer | The unique identifier for the experience. |
name | String | The name of the experience. |
description | String | The description of the experience. |
objective | String | The objective of the experience. |
type | String | The type of the experience. |
status | String | The status of the experience. |
start_time | Integer | The start time of the experience. |
end_time | Integer | The end time of the experience. |
global_js | String | The global JavaScript for the experience. |
global_css | String | The global CSS for the experience. |
url | String | The URL of the experience. |
environment | String | The environment of the experience. |
project | Object | The project associated with the experience. |
primary_goal | Integer | The primary goal ID for the experience. |
traffic_distribution | Number | The traffic distribution for the experience. |
settings | Object | The settings for the experience. |
version | Integer | The version of the experience. |
integrations | Array of Objects | The integrations for the experience. |
key | String | The key for the experience. |
screenshots_info | Array of Objects | Information about screenshots for the experience. |
site_area | String | The site area for the experience. |
concurrency_key | String | The concurrency key for the experience. |
stats | Object | The statistics for the experience. |
min_running_timestamp | Integer | The minimum running timestamp for the experience. |
max_running_timestamp | Integer | The maximum running timestamp for the experience. |
variations | Array of Objects | The variations for the experience. |
goals | Array of Objects | The goals for the experience. |
locations | Array of Objects | The locations for the experience. |
tags | Array of Strings | The tags for the experience. |