Quickstart Transformations Management Private Preview
Overview
The Fivetran Quickstart Transformations Management API provides a more granular control of Quickstart Transformations.
Supported features
Once you have access to the Fivetran API, you can call the following API endpoints:
- Create Quickstart Package
- Retrieve Quickstart Packages
- Retrieve Quickstart Package Details
- Modify Quickstart Package
- Upgrade Quickstart Package version
- Delete Quickstart Package
- Retrieve Quickstart Package Models
- Create Quickstart Transformation
- Retrieve Quickstart Transformations
- Retrieve Quickstart Transformation Details
- Modify Quickstart Transformation
- Delete Quickstart Transformation
- Cancel Quickstart Transformation
- Run Quickstart Transformation
Create Quickstart Package
Creates a new Quickstart package for the provided connection. Note that all transformations corresponding to the package models will also be automatically created.
Request
POST https://api.fivetran.com/v1/qdm/packages
{
"connection_ids": ["connection_id"],
"exclude_models": ["model_name", "another_model_name"],
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
}
}
Payload parameters
Name | Description |
---|---|
connection_ids (required) | The unique identifiers list for the connection within your Fivetran account. |
schedule (required) | The Quickstart package transformations schedule: all transformations within the package will be assigned with this schedule. |
exclude_models | The set of output models to be excluded from the package when it's created. |
schedule.schedule_type (required) | The type of the schedule to run the package transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
schedule.days_of_week | The set of the days of the week the package transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
schedule.interval | The time interval in minutes between the subsequent package transformation runs. |
schedule.time_of_day | The time of the day the package transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
Response
HTTP 201 Created
{
"code": "Success",
"message": "Quickstart package has been created",
"data": {
"id": "qdm_package_id",
"group_id": "group_id",
"connection_id": "connection_id",
"version": "1.0.0",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"created_at": "2043-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart package within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
connection_id | The unique identifier for the connection within the Fivetran system. |
version | The package definition version that is used for the package. |
schedule | The Quickstart package transformations schedule: all transformations within the package will run according to this schedule. |
schedule.schedule_type | The type of the schedule to run the Quickstartpackage transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
schedule.days_of_week | The set of the days of the week the Quickstartpackage transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
schedule.interval | The time interval in minutes between the subsequent Quickstartpackage transformation runs. |
schedule.time_of_day | The time of the day the Quickstartpackage transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
created_at | The timestamp when the Quickstart package was created. |
created_by_id | The unique identifier for the user within the Fivetran system who created the Quickstart package. |
Retrieve Quickstart Packages
Retrieves a list of all Quickstart packages within your Fivetran account or withing the specified group in your account.
Request
GET https://api.fivetran.com/v1/qdm/packages
Query parameters
Name | Description |
---|---|
group_id | The unique identifier for the group within the Fivetran system. If specified, the list of Quickstart packages is filtered by the specified group. Otherwise, the list of Quickstart packages the user has access to is returned. |
cursor | The paging cursor. Read more about pagination in our documentation. |
limit | The number of records to fetch per page, accepts a number in the range 1..1000. The default value is 100. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "qdm_package_id",
"group_id": "group_id",
"connection_id": "connection_id",
"version": "1.0.0",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"created_at": "2043-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id"
}
],
"next_cursor": "eyJza2lwIjoxMDB9"
}
}
Name | Description |
---|---|
items | The collection of Quickstart packages. |
id | The unique identifier for the Quickstart package within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
connection_id | The unique identifier for the connection within the Fivetran system. |
version | The package definition version that is used for the package. |
schedule | The Quickstart package transformations schedule: all transformations within the package will run according to this schedule. |
schedule.schedule_type | The type of the schedule to run the Quickstart package transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
schedule.days_of_week | The set of the days of the week the Quickstart package transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
schedule.interval | The time interval in minutes between the subsequent Quickstart package transformation runs. |
schedule.time_of_day | The time of the day the Quickstart package transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
created_at | The timestamp when the Quickstart package was created. |
created_by_id | The unique identifier for the user within the Fivetran system who created the Quickstart package. |
Retrieve Quickstart Package Details
Retrieves the details of the specified Quickstart package.
Request
GET https://api.fivetran.com/v1/qdm/packages/{package_id}
Path parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "qdm_package_id",
"group_id": "group_id",
"connection_id": "connection_id",
"version" : "1.0.0",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"created_at": "2043-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart package within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
connection_id | The unique identifier for the connection within the Fivetran system. |
version | The package definition version that is used for the package. |
schedule | The Quickstart package transformations schedule: all transformations within the package will run according to this schedule. |
schedule_type | The type of the schedule to run the Quickstart package transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
days_of_week | The set of the days of the week the Quickstart package transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
interval | The time interval in minutes between the subsequent Quickstart package transformation runs. |
time_of_day | The time of the day the Quickstart package transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
created_at | The timestamp when the Quickstart package was created. |
created_by_id | The unique identifier for the user within the Fivetran system who created the Quickstart package. |
Modify Quickstart Package
Updates the specified Quickstart package with the specified parameters.
Request
PATCH https://api.fivetran.com/v1/qdm/packages/{package_id}
{
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
}
}
Path parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
Payload parameters
Name | Description |
---|---|
schedule (required) | The Quickstart package transformations schedule: all transformations within the package will be assigned with this schedule. |
schedule_type (required) | The type of the schedule to run the package transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
days_of_week | The set of the days of the week the package transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
interval | The time interval in minutes between the subsequent package transformation runs. |
time_of_day | The time of the day the package transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Package with id 'qdm_package_id' has been updated",
"data": {
"id": "qdm_package_id",
"group_id": "group_id",
"connection_id": "connection_id",
"version": "1.0.0",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"created_at": "2043-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart package within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
connection_id | The unique identifier for the connection within the Fivetran system. |
version | The package definition version that is used for the package. |
schedule | The Quickstart package transformations schedule: all transformations within the package will run according to this schedule. |
schedule_type | The type of the schedule to run the Quickstart package transformations on. The following values are supported: INTEGRATED , TIME_OF_DAY , INTERVAL . For the INTEGRATED schedule type, the interval and time_of_day values are ignored and only the days_of_week parameter values are taken into account (but may be empty or null ). For the TIME_OF_DAY schedule type, the interval parameter value is ignored, and the time_of_day value is taken into account along with the days_of_week values. For the INTERVAL schedule type, the time_of_day value is ignored, and the interval parameter value is taken into account along with the days_of_week values. |
days_of_week | The set of the days of the week the Quickstart package transformations should be launched on. The following values are supported: MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY . |
interval | The time interval in minutes between the subsequent Quickstart package transformation runs. |
time_of_day | The time of the day the Quickstart package transformations should be launched at. We support ISO time format, such as 10:15 or 10:15:30 . |
created_at | The timestamp when the Quickstart package was created. |
created_by_id | The unique identifier for the user within the Fivetran system who created the Quickstart package. |
Upgrade Quickstart Package version
Upgrades the package version to the latest possible definition version.
Request
POST https://api.fivetran.com/v1/qdm/packages/{package_id}/upgrade
Path parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
Responses
HTTP 200 OK
{
"code": "Success",
"message": "Quickstart Data Model Package has been updated to the latest version `1.2.2`."
}
HTTP 409 CONFLICT
{
"code": "Failed",
"message": "The package is already set up for the latest version."
}
Delete Quickstart Package
Deletes the specified Quickstart package with all its transformations.
Request
DELETE https://api.fivetran.com/v1/qdm/packages/{package_id}
Path parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Quickstart package has been deleted"
}
Retrieve Quickstart Package Models
Retrieves a list of all Quickstart models within the specified Quickstart package.
Request
GET https://api.fivetran.com/v1/qdm/packages/{package_id}/models
Path parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
Query parameters
Name | Description |
---|---|
cursor | The paging cursor. Read more about pagination in our documentation. |
limit | The number of records to fetch per page, accepts a number in the range 1..1000. The default value is 100. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "qdm_model_id",
"name": "qdm_model_name",
"selected": false
}
],
"next_cursor": "eyJza2lwIjoxMDB9"
}
}
Name | Description |
---|---|
items | The collection of Quickstart package models. |
id | The unique identifier for the Quickstart model within the Fivetran system. |
name | The Quickstart model name. |
selected | The boolean specifying whether the model is selected for execution. |
Create Quickstart Transformation
Creates new Quickstart transformation for the specified Quickstart model.
Request
POST https://api.fivetran.com/v1/qdm/transformations
{
"model_id": "qdm_model_id",
"run_tests": true,
"paused": true
}
Payload parameters
Name | Description |
---|---|
model_id (required) | The unique identifier for the Quickstart model within the Fivetran system. |
run_tests (required) | The boolean indicating whether the tests have been configured for transformation. |
paused (required) | The boolean indicating whether the transformation will be created in paused state. |
Response
HTTP 201 Created
{
"code": "Success",
"message": "Transformation has been created",
"data": {
"id": "qdm_transformation_id",
"name": "qdm_transformation_name",
"package_id": "qdm_package_id",
"status": "PENDING",
"run_tests": true,
"paused": true,
"last_run": "2024-01-01T00:00:00.743708Z",
"next_run": "2024-01-02T00:00:00.743708Z",
"selected_by_id": "selected_by_id",
"selected_at": "2024-01-01T00:00:00.743708Z",
"edited_by_id": "edited_by_id",
"edited_at": "2024-01-01T00:00:00.743708Z"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart transformation within the Fivetran system. Quickstart transformation IDs are mapped 1:1 to Quickstart model IDs. |
name | The Quickstart transformation name. The name is the same as the corresponding Quickstart model name. |
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
status | The status of transformation. Possible values are: SUCCEEDED , SCHEDULING , RUNNING , TERMINATING , FAILED , PENDING , BLOCKED , PAUSED , CANCELED . |
run_tests | The boolean specifying whether the tests have been configured for transformation. |
paused | The boolean indicating whether the transformation is in paused state. |
last_run | The timestamp of the last transformation run. |
next_run | The timestamp of the next transformation run. |
selected_by_id | The unique identifier for the user within the Fivetran system who selected the specified Quickstart transformation to run. |
selected_at | The timestamp when the Quickstart transformation was selected. |
edited_by_id | The unique identifier for the user within the Fivetran system who edited the Quickstart transformation. |
edited_at | The timestamp when the Quickstart transformation was edited. |
Retrieve Quickstart Transformations
Retrieves a list of all Quickstart transformations within your Fivetran account or within the specified Quickstart package in your account.
Request
GET https://api.fivetran.com/v1/qdm/transformations
Query parameters
Name | Description |
---|---|
package_id | The unique identifier for the Quickstart package within the Fivetran system. If specified, the list of Quickstart transformations is filtered by the specified Quickstart package. Otherwise, the list of Quickstart transformations the user has access to is returned. |
cursor | The paging cursor. Read more about pagination in our documentation. |
limit | The number of records to fetch per page, accepts a number in the range 1..1000. The default value is 100. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "qdm_transformation_id",
"name": "qdm_transformation_name",
"package_id": "qdm_package_id",
"status": "PENDING",
"run_tests": true,
"paused": true,
"last_run": "2024-01-01T00:00:00.743708Z",
"next_run": "2024-01-02T00:00:00.743708Z"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart transformation within the Fivetran system. Quickstart transformation IDs are mapped 1:1 to Quickstart model IDs. |
name | The Quickstart transformation name. The name is the same as the corresponding Quickstart model name. |
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
status | The status of transformation. Possible values are: SUCCEEDED , SCHEDULING , RUNNING , TERMINATING , FAILED , PENDING , BLOCKED , PAUSED , CANCELED . |
run_tests | The boolean specifying whether the tests have been configured for transformation. |
paused | The boolean indicating whether the transformation is in paused state. |
last_run | The timestamp of the last transformation run. |
next_run | The timestamp of the next transformation run. |
Retrieve Quickstart Transformation Details
Retrieves the details for the specified Quickstart transformation.
Request
GET https://api.fivetran.com/v1/qdm/transformations/{transformation_id}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the Quickstart transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "qdm_transformation_id",
"name": "qdm_transformation_name",
"package_id": "qdm_package_id",
"status": "PENDING",
"run_tests": true,
"paused": true,
"last_run": "2024-01-01T00:00:00.743708Z",
"next_run": "2024-01-02T00:00:00.743708Z",
"selected_by_id": "selected_by_id",
"selected_at": "2024-01-01T00:00:00.743708Z",
"edited_by_id": "edited_by_id",
"edited_at": "2024-01-01T00:00:00.743708Z"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart transformation within the Fivetran system. Quickstart transformation IDs are mapped 1:1 to Quickstart model IDs. |
name | The Quickstart transformation name. The name is the same as the corresponding Quickstart model name. |
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
status | The status of transformation. Possible values are: SUCCEEDED , SCHEDULING , RUNNING , TERMINATING , FAILED , PENDING , BLOCKED , PAUSED , CANCELED . |
run_tests | The boolean specifying whether the tests have been configured for transformation. |
paused | The boolean indicating whether the transformation is in paused state. |
last_run | The timestamp of the last transformation run. |
next_run | The timestamp of the next transformation run. |
selected_by_id | The unique identifier for the user within the Fivetran system who selected the specified Quickstart transformation to run. |
selected_at | The timestamp when the Quickstart transformation was selected. |
edited_by_id | The unique identifier for the user within the Fivetran system who edited the Quickstart transformation. |
edited_at | The timestamp when the Quickstart transformation was edited. |
Modify Quickstart Transformation
Updates an existing Quickstart transformation with the specified parameters.
Request
PATCH https://api.fivetran.com/v1/qdm/transformations/{transformation_id}
{
"run_tests": true,
"paused": true
}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the Quickstart transformation within the Fivetran system. |
Payload parameters
Name | Description |
---|---|
run_tests | The boolean specifying whether the tests have been configured for transformation. |
paused | The boolean indicating whether the transformation is in paused state. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation has been updated",
"data": {
"id": "qdm_transformation_id",
"name": "qdm_transformation_name",
"package_id": "qdm_package_id",
"status": "PENDING",
"run_tests": true,
"paused": true,
"last_run": "2024-01-01T00:00:00.743708Z",
"next_run": "2024-01-02T00:00:00.743708Z",
"selected_by_id": "selected_by_id",
"selected_at": "2024-01-01T00:00:00.743708Z",
"edited_by_id": "edited_by_id",
"edited_at": "2024-01-01T00:00:00.743708Z"
}
}
Name | Description |
---|---|
id | The unique identifier for the Quickstart transformation within the Fivetran system. Quickstart transformation IDs are mapped 1:1 to Quickstart model IDs. |
name | The Quickstart transformation name. The name is the same as the corresponding Quickstart model name. |
package_id | The unique identifier for the Quickstart package within the Fivetran system. |
status | The status of transformation. Possible values are: SUCCEEDED , SCHEDULING , RUNNING , TERMINATING , FAILED , PENDING , BLOCKED , PAUSED , CANCELED . |
run_tests | The boolean specifying whether the tests have been configured for transformation. |
paused | The boolean indicating whether the transformation is in paused state. |
last_run | The timestamp of the last transformation run. |
next_run | The timestamp of the next transformation run. |
selected_by_id | The unique identifier for the user within the Fivetran system who selected the specified Quickstart transformation to run. |
selected_at | The timestamp when the Quickstart transformation was selected. |
edited_by_id | The unique identifier for the user within the Fivetran system who edited the Quickstart transformation. |
edited_at | The timestamp when the Quickstart transformation was edited. |
Delete Quickstart Transformation
Deletes the specified Quickstart transformation.
Request
DELETE https://api.fivetran.com/v1/qdm/transformations/{transformation_id}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the Quickstart transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Quickstart transformation has been deleted"
}
Cancel Quickstart Transformation
Cancels the specified Quickstart transformation.
Request
POST https://api.fivetran.com/v1/qdm/transformations/{transformation_id}/cancel
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the Quickstart transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' cancellation is in progress"
}
Run Quickstart Transformation
Runs the specified Quickstart transformation.
Request
POST https://api.fivetran.com/v1/qdm/transformations/{transformation_id}/run
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the Quickstart transformation within the Fivetran system. |
Payload parameters
Name | Description |
---|---|
full_refresh | Optional boolean parameter. If the parameter is passed with the value true then the specified transformation will run with full refresh, i.e. all resulting tables will be deleted and recreated |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' has been started"
}