Transformations for dbt Core Management Beta
Overview
The Fivetran Transformations for dbt Core Management API provides more granular control around dbt Transformations. These transformations tend to be more complex, and have many cross-connector and cross-project dependencies. In conjunction with the webhooks, the Transformations for dbt Core Management API allows custom data pipeline orchestration.
IMPORTANT: Our REST API only supports Scheduled in Fivetran transformations for dbt Core*. Our REST API does not support Scheduled in code transformations for dbt Core and Quickstart Models.
* dbt Core is a trademark of dbt Labs, Inc. All rights therein are reserved to dbt Labs, Inc. Fivetran Transformations is not a product or service of or endorsed by dbt Labs, Inc.
Supported features
Once you have access to the Fivetran API, you can call the following API endpoints:
- Create dbt Project
- Retrieve dbt Projects
- Retrieve dbt Project details
- Modify a dbt Project
- Test dbt Project
- Retrieve dbt Project Models
- Retrieve dbt Project Model details
- Create dbt Transformation
- Retrieve dbt Transformations
- Retrieve dbt Transformation details
- Modify dbt Transformation
- Delete dbt Transformation
- Cancel dbt Transformation
- Run dbt Transformation
- Pause dbt Transformation
- Resume dbt Transformation
Create dbt Project
Connects a new dbt Core project to your Fivetran account.
Request
POST https://api.fivetran.com/v1/dbt/projects
{
"group_id": "group_id",
"dbt_version": "dbt_version",
"default_schema": "default_schema",
"target_name": "target_name",
"threads": 1,
"environment_vars": ["DBT_VARIABLE_1=VALUE", "DBT_VARIABLE_2=VALUE"],
"type": "GIT",
"project_config": {
"git_remote_url": "git_remote_url",
"git_branch": "git_branch",
"folder_path": "folder_path"
}
}
Payload parameters
Name | Description |
---|---|
group_id (required) | The unique identifier for the group within the Fivetran system. Find you group_id by fetching your account's group list. |
dbt_version (required) | The version of dbt that should run the project. We support the following versions: 1.0.0, 1.0.1, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.5, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.6, 1.3.0, 1.3.1, 1.3.2, 1.3.7, 1.4.5, 1.4.9, 1.5.1, 1.5.6, 1.5.8, 1.5.9, 1.6.0, 1.6.1, 1.6.3, 1.6.6, 1.6.9, 1.7.3, 1.7.9 |
default_schema (required) | Default schema in destination. This production schema will contain your transformed data. |
target_name | Target name to set or override the value from the deployment.yaml |
threads | The number of threads dbt will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse. |
environment_vars | List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value" |
type | The project type. We only support the GIT project type. Default value: GIT . |
project_config | The specific project type configuration. We only support Git-based projects. |
project_config.git_remote_url (required) | The Git remote URL of your dbt project. |
project_config.git_branch | The Git branch. Default value: main . |
project_config.folder_path | The folder path of your dbt project in the Git repository. |
Response
HTTP 201 Created
{
"code": "Success",
"message": "DBT Project has been created",
"data": {
"id": "dbt_project_id",
"group_id": "group_id",
"dbt_version": "dbt_version",
"created_at": "2023-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id",
"public_key": "public_key",
"default_schema": "default_schema",
"target_name": "target_name",
"environment_vars": ["DBT_VARIABLE_1=VALUE", "DBT_VARIABLE_2=VALUE"],
"threads": 1,
"type": "GIT",
"status": "NOT_READY",
"project_config": {
"git_remote_url": "git_remote_url",
"git_branch": "git_branch",
"folder_path": "folder_path"
}
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Project within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
dbt_version | The version of dbt that should run the project. Possible values: 0.18.0, 0.18.1, 0.18.2, 0.19.0, 0.19.1, 0.19.2, 0.20.0, 0.20.1, 0.20.2, 0.21.0, 0.21.1, 1.0.0, 1.0.1, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.3.0, 1.3.1, 1.3.2, 1.4.5, 1.5.1, 1.5.6, 1.6.0, 1.6.1, 1.6.3 |
created_at | The timestamp when dbt project was created. |
created_by_id | The unique identifier for the User within the Fivetran system who created the DBT Project. |
public_key | Public key to grant Fivetran SSH access to git repository. |
default_schema | Default schema in destination. |
target_name | Target name to set or override the value from the deployment.yaml |
environment_vars | List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value" |
threads | The number of threads dbt will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse. |
type | The project type. We only support the GIT project type. |
status | DBT project readiness status. Possible values NOT_READY , READY , ERROR |
project_config | The specific project type configuration. |
project_config.git_remote_url | The Git remote URL of your dbt project. |
project_config.git_branch | The Git branch. |
project_config.folder_path | The folder path of your dbt project in the Git repository. |
Retrieve dbt Projects
Retrieves a list of all dbt Projects within your Fivetran account or withing the specified Group in your account.
Request
GET https://api.fivetran.com/v1/dbt/projects
Query parameters
Name | Description |
---|---|
group_id | The unique identifier for the Group within the Fivetran system. If specified the list of dbt Projects is filtered by the specified Group. |
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": "dbt_project_id",
"group_id": "project_group_id",
"created_at": "2023-01-01T00:00:00.743708Z",
"created_by_id": "user_id"
}
],
"next_cursor": "eyJza2lwIjoxMDB9"
}
}
Name | Description |
---|---|
items | The collection of dbt Projects. |
id | The unique identifier for the dbt Project within the Fivetran system. |
group_id | The unique identifier for the Group within the Fivetran system. |
created_at | The timestamp when dbt project was created. |
created_by_id | The unique identifier for the User within the Fivetran system who created the DBT Project. |
Retrieve dbt Project details
Retrieves the details of the specified dbt Project.
Request
GET https://api.fivetran.com/v1/dbt/projects/{project_id}
Path parameters
Name | Description |
---|---|
project_id | The unique identifier for the dbt Project within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "dbt_project_id",
"group_id": "group_id",
"dbt_version": "1.4.5",
"created_at": "2023-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id",
"public_key": "public_key",
"default_schema": "default_schema",
"target_name": "target_name",
"threads": 1,
"environment_vars": ["DBT_VARIABLE_1=VALUE", "DBT_VARIABLE_2=VALUE"],
"type": "GIT",
"status": "NOT_READY",
"project_config": {
"git_remote_url": "git_remote_url",
"git_branch": "git_branch",
"folder_path": "folder_path"
}
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Project within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
dbt_version | The version of dbt that should run the project. Possible values: 0.18.0, 0.18.1, 0.18.2, 0.19.0, 0.19.1, 0.19.2, 0.20.0, 0.20.1, 0.20.2, 0.21.0, 0.21.1, 1.0.0, 1.0.1, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.3.0, 1.3.1, 1.3.2, 1.4.5, 1.5.1, 1.5.6, 1.6.0, 1.6.1, 1.6.3 |
created_at | The timestamp when dbt project was created. |
created_by_id | The unique identifier for the User within the Fivetran system who created the dbt Project. |
public_key | Public key to grant Fivetran SSH access to git repository. |
default_schema | Default schema in destination. |
target_name | Target name to set or override the value from the deployment.yaml |
threads | The number of threads dbt will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse. |
environment_vars | List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value" |
type | The project type. We only support the GIT project type. |
status | DBT project readiness status. Possible values NOT_READY , READY , ERROR |
project_config | The specific project type configuration. We only support Git-based projects. |
project_config.git_remote_url | The Git remote URL of your dbt project. |
project_config.git_branch | The Git branch. |
project_config.folder_path | The folder path of your dbt project in the Git repository. |
Modify a dbt Project
Updates an existing dbt Project with the specified parameters.
Request
PATCH https://api.fivetran.com/v1/dbt/projects/{project_id}
{
"dbt_version": "dbt_version",
"target_name": "target_name",
"threads": 1,
"environment_vars": ["DBT_VARIABLE_1=VALUE", "DBT_VARIABLE_2=VALUE"],
"project_config": {
"git_branch": "git_branch",
"folder_path": "folder_path"
}
}
Path parameters
Name | Description |
---|---|
project_id | The unique identifier for the dbt Project within the Fivetran system. |
Payload parameters
Name | Description |
---|---|
dbt_version | The version of dbt that should run the project. We support the following versions: 1.0.0, 1.0.1, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.5, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.6, 1.3.0, 1.3.1, 1.3.2, 1.3.7, 1.4.5, 1.4.9, 1.5.1, 1.5.6, 1.5.8, 1.5.9, 1.6.0, 1.6.1, 1.6.3, 1.6.6, 1.6.9, 1.7.3, 1.7.9 |
target_name | Target name to set or override the value from the deployment.yaml |
threads | The number of threads dbt will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse. |
environment_vars | List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value" |
project_config | The specific project type configuration. We only support Git-based projects. |
project_config.git_branch | The Git branch. |
project_config.folder_path | The folder path of your dbt project in the Git repository. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "DBT Project has been updated",
"data": {
"id": "dbt_project_id",
"group_id": "group_id",
"created_at": "2023-01-01T00:00:00.743708Z",
"created_by_id": "created_by_id",
"public_key": "public_key",
"default_schema": "default_schema",
"target_name": "target_name",
"threads": 1,
"environment_vars": ["DBT_VARIABLE_1=VALUE", "DBT_VARIABLE_2=VALUE"],
"type": "GIT",
"project_config": {
"git_remote_url": "git_remote_url",
"git_branch": "git_branch",
"folder_path": "folder_path"
}
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Project within the Fivetran system. |
group_id | The unique identifier for the group within the Fivetran system. |
created_at | The timestamp when dbt project was created. |
created_by_id | The unique identifier for the User within the Fivetran system who created the dbt Project. |
public_key | Public key to grant Fivetran SSH access to git repository. |
default_schema | Default schema in destination. |
target_name | Target name to set or override the value from the deployment.yaml |
threads | The number of threads dbt will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse. |
environment_vars | List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value" |
type | The project type. We only support the GIT project type. |
project_config | The specific project type configuration. We only support Git-based projects. |
project_config.git_remote_url | The Git remote URL of your dbt project. |
project_config.git_branch | The Git branch. |
project_config.folder_path | The folder path of your dbt project in the Git repository. |
Test dbt Project
Runs setup tests for the specified dbt Project.
Request
POST https://api.fivetran.com/v1/dbt/projects/{project_id}/test
Path parameters
Name | Description |
---|---|
project_id | The unique identifier for the dbt Project within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"dbt_project_id": "dbt_project_id",
"setup_tests": [
{
"title": "title",
"status": "status",
"message": "message"
}
]
}
}
Name | Description |
---|---|
dbt_project_id | The unique identifier for the dbt Project within the Fivetran system. |
setup_tests | The collection of setup tests executed for the dbt Project. |
title | Setup test title. |
status | Test status. |
message | Additional message. |
Retrieve dbt Project models
Retrieves a list of all dbt Models within the specified dbt Project.
Request
GET https://api.fivetran.com/v1/dbt/models
Query parameters
Name | Description |
---|---|
project_id | The unique identifier for the dbt Project within the Fivetran system. |
cursor | paging cursor, read more about pagination |
limit | 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": "model_id",
"model_name": "model_name",
"scheduled": true
}
],
"next_cursor": "eyJza2lwIjoxMDB9"
}
}
Name | Description |
---|---|
items | The collection of dbt models. |
id | The unique identifier for the dbt Model within the Fivetran system. |
model_name | The dbt Model name. |
scheduled | Boolean specifying whether the model is selected for execution in the dashboard. |
Retrieve dbt Project Model details
Retrieves the details for the specified dbt Model.
Request
GET https://api.fivetran.com/v1/dbt/models/{model_id}
Path parameters
Name | Description |
---|---|
model_id | The unique identifier for the dbt Model within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "model_id",
"model_name": "model_name",
"scheduled": true
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Model within the Fivetran system. |
model_name | The dbt Model name. |
scheduled | Boolean specifying whether the model is selected for execution in the dashboard. |
Create dbt Transformation
Creates and schedules a transformation from your connected dbt Core project.
Request
POST https://api.fivetran.com/v1/dbt/transformations
{
"dbt_model_id": "dbt_model_id",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"run_tests": true,
"paused": true
}
Payload parameters
Name | Description |
---|---|
dbt_model_id (required) | The unique identifier for the dbt Model within the Fivetran system. |
schedule (required) | The transformation schedule. |
schedule_type (required) | The type of the schedule to run the transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL. For INTEGRATED schedule type, 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 TIME_OF_DAY schedule type, the interval parameter value is ignored and the time_of_day values is taken into account along with days_of_week value. For INTERVAL schedule type, time_of_day value is ignored and the interval parameter value is taken into account along with days_of_week value. |
days_of_week | The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
interval | The time interval in minutes between subsequent transformation runs. |
time_of_day | The time of the day the transformation should be launched at. The following values are supported: 00:00 , 00:30 , 01:00 , 01:30 , 02:00 , 02:30 , 03:00 , 03:30 , 04:00 , 04:30 , 05:00 , 05:30 , 06:00 , 06:30 , 07:00 , 07:30 , 08:00 , 08:30 , 09:00 , 09:30 , 10:00 , 10:30 , 11:00 , 11:30 , 12:00 , 12:30 , 13:00 , 13:30 , 14:00 , 14:30 , 15:00 , 15:30 , 16:00 , 16:30 , 17:00 , 17:30 , 18:00 , 18:30 , 19:00 , 19:30 , 20:00 , 20:30 , 21:00 , 21:30 , 22:00 , 22:30 , 23:00 , 23:30 |
run_tests | The field indicating whether the tests have been configured for transformation. By default, the value is false. |
paused | The field indicating whether the transformation will be created in paused state. By default, the value is false. |
Response
HTTP 201 Created
{
"code": "Success",
"message": "Transformation has been created",
"data": {
"id": "dbt_transformation_id",
"status": "PENDING",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"last_run": "2023-01-01T00:00:00.743708Z",
"run_tests": true,
"model_ids": ["model_id_1", "model_id_2"],
"output_model_name": "model_name",
"dbt_project_id": "dbt_project_id",
"dbt_model_id": "dbt_model_id",
"connector_ids": ["connector_id_1", "connector_id_2"],
"next_run": "2023-01-02T00:00:00.743708Z",
"created_at": "2023-01-01T00:00:00.743708Z",
"paused": true
}
}
Name | Description |
---|---|
id | The unique identifier for the transformation within the Fivetran system. |
status | The status of transformation. Possible values are: SUCCEEDED, RUNNING, FAILED, PENDING |
schedule | The transformation schedule. |
schedule_type | The type of the schedule to run the transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL. |
days_of_week | The set of the days of the week the transformation should be launched on. |
interval | The time interval in minutes between subsequent transformation runs. |
time_of_day | A time of the day the transformation should be launched at. |
last_run | The timestamp of the last transformation run. |
run_tests | Boolean specifying whether the tests have been configured for transformation. |
model_ids | Identifiers of related models. |
output_model_name | The dbt Model name. |
dbt_project_id | The unique identifier for the dbt Project within the Fivetran system. |
dbt_model_id | The unique identifier for the dbt Model within the Fivetran system. |
connector_ids | Identifiers of related connectors. |
next_run | The timestamp of the next transformation run. |
paused | The field indicating whether the transformation will be created in paused state. |
created_at | The timestamp when dbt project was created. |
Retrieve dbt Transformations
Retrieves a list of all transformations within the specified dbt Project.
IMPORTANT: The
project_id
query parameter is mandatory.
Request
GET https://api.fivetran.com/v1/dbt/transformations
Query parameters
Name | Description |
---|---|
project_id | The unique identifier for the dbt Project within the Fivetran system. |
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": "dbt_transformation_id",
"status": "PENDING",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"last_run": "2023-01-01T00:00:00.743708Z",
"run_tests": true,
"output_model_name": "model_name",
"dbt_project_id": "dbt_project_id",
"dbt_model_id": "dbt_model_id",
"next_run": "2023-01-02T00:00:00.743708Z",
"paused": false
}
],
"next_cursor": "eyJza2lwIjoxMDB9"
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Transformation within the Fivetran system. |
status | The status of dbt Transformation. Possible values are: SUCCEEDED, RUNNING, FAILED, PENDING |
schedule | The dbt Transformation schedule. |
schedule.schedule_type | The type of the schedule to run the dbt Transformation with. |
schedule.days_of_week | The set of the days of the week the transformation should be launched on. |
schedule.interval | The time interval in minutes between subsequent transformation runs. |
schedule.time_of_day | The time of the day the transformation should be launched at. |
last_run | The timestamp of last dbt Transformation run. |
run_tests | Boolean specifying whether the tests have been configured for dbt Transformation. |
output_model_name | The dbt Model name. |
dbt_project_id | The unique identifier for the dbt Project within the Fivetran system. |
dbt_model_id | The unique identifier for the dbt Model within the Fivetran system. |
next_run | The timestamp of the next dbt Transformation run. |
paused | The field indicating whether the transformation will be created in paused state. |
Retrieve dbt Transformation details
Retrieves the details for the specified dbt Transformation.
Request
GET https://api.fivetran.com/v1/dbt/transformations/{transformation_id}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "dbt_transformation_id",
"status": "PENDING",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"last_run": "2023-01-01T00:00:00.743708Z",
"run_tests": true,
"model_ids": ["model_id_1", "model_id_2"],
"output_model_name": "model_name",
"dbt_project_id": "dbt_project_id",
"dbt_model_id": "dbt_model_id",
"connector_ids": ["connector_id_1", "connector_id_2"],
"next_run": "2023-01-02T00:00:00.743708Z",
"paused": false
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Transformation within the Fivetran system. |
status | The status of dbt Transformation. Possible values are: SUCCEEDED, RUNNING, FAILED, PENDING |
schedule | The dbt Transformation schedule. |
schedule.schedule_type | The type of the schedule to run the dbt Transformation with. |
schedule.days_of_week | The set of the days of the week the transformation should be launched on. |
schedule.interval | The time interval in minutes between subsequent transformation runs. |
schedule.time_of_day | The time of the day the transformation should be launched at. |
last_run | The timestamp of last dbt Transformation run. |
run_tests | Boolean specifying whether the tests have been configured for dbt Transformation. |
model_ids | Identifiers of related models. |
output_model_name | The dbt Model name. |
dbt_project_id | The unique identifier for the dbt Project within the Fivetran system. |
dbt_model_id | The unique identifier for the dbt Model within the Fivetran system. |
connector_ids | Identifiers of related connectors. |
next_run | The timestamp of the next dbt Transformation run. |
paused | The field indicating whether the transformation will be created in paused state. |
Modify dbt Transformation
Modifies the specified dbt Transformation.
Request
PATCH https://api.fivetran.com/v1/dbt/transformations/{transformation_id}
{
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"run_tests": true,
"paused": true
}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Payload parameters
Name | Description |
---|---|
schedule | The dbt Transformation schedule. |
schedule.schedule_type | The type of the schedule to run the dbt Transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL. For INTEGRATED schedule type, 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 TIME_OF_DAY schedule type, the interval parameter value is ignored and the time_of_day values is taken into account along with days_of_week value. For INTERVAL schedule type, time_of_day value is ignored and the interval parameter value is taken into account along with days_of_week value. |
schedule.days_of_week | The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
schedule.interval | The time interval in minutes between subsequent transformation runs. |
schedule.time_of_day | The time of the day the transformation should be launched at. The following values are supported: 00:00 , 00:30 , 01:00 , 01:30 , 02:00 , 02:30 , 03:00 , 03:30 , 04:00 , 04:30 , 05:00 , 05:30 , 06:00 , 06:30 , 07:00 , 07:30 , 08:00 , 08:30 , 09:00 , 09:30 , 10:00 , 10:30 , 11:00 , 11:30 , 12:00 , 12:30 , 13:00 , 13:30 , 14:00 , 14:30 , 15:00 , 15:30 , 16:00 , 16:30 , 17:00 , 17:30 , 18:00 , 18:30 , 19:00 , 19:30 , 20:00 , 20:30 , 21:00 , 21:30 , 22:00 , 22:30 , 23:00 , 23:30 |
run_tests | The field indicating whether the tests have been configured for dbt Transformation. By default, the value is false. |
paused | The field indicating whether the transformation will be created in paused state. By default, the value is false. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation has been updated",
"data": {We support ISO time format
"id": "dbt_transformation_id",
"status": "PENDING",
"schedule": {
"schedule_type": "TIME_OF_DAY",
"days_of_week": ["MONDAY", "TUESDAY", "TUESDAY", "TUESDAY", "FRIDAY"],
"interval": 15,
"time_of_day": "12:00"
},
"last_run": "2023-01-01T00:00:00.743708Z",
"run_tests": true,
"model_ids": ["model_id_1", "model_id_2"],
"output_model_name": "model_name",
"dbt_project_id": "dbt_project_id",
"dbt_model_id": "dbt_model_id",
"connector_ids": ["connector_id_1", "connector_id_2"],
"next_run": "2023-01-02T00:00:00.743708Z",
"paused": true
}
}
Name | Description |
---|---|
id | The unique identifier for the dbt Transformation within the Fivetran system. |
status | The status of dbt Transformation. Possible values are: SUCCEEDED, RUNNING, FAILED, PENDING |
schedule | The dbt Transformation schedule. |
schedule.schedule_type | The type of the schedule to run the dbt Transformation with. |
schedule.days_of_week | The set of the days of the week the transformation should be launched on. |
schedule.interval | The time interval in minutes between subsequent transformation runs. |
schedule.time_of_day | The time of the day the transformation should be launched at. |
last_run | The timestamp of last dbt Transformation run. |
run_tests | Boolean specifying whether the tests have been configured for dbt Transformation. |
model_ids | Identifiers of related models. |
output_model_name | The dbt Model name. |
dbt_project_id | he unique identifier for the dbt Project within the Fivetran system. |
dbt_model_id | The unique identifier for the dbt Model within the Fivetran system. |
connector_ids | Identifiers of related connectors. |
next_run | The timestamp of the next dbt Transformation run. |
paused | The field indicating whether the transformation will be created in paused state. |
Delete dbt Transformation
Deletes the specified dbt Transformation.
Request
DELETE https://api.fivetran.com/v1/dbt/transformations/{transformation_id}
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' has been deleted"
}
Cancel dbt Transformation
Cancels the specified dbt Transformation.
Request
POST https://api.fivetran.com/v1/dbt/transformations/{transformation_id}/cancel
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' cancellation is in progress"
}
Run dbt Transformation
Runs the specified dbt Transformation.
Request
POST https://api.fivetran.com/v1/dbt/transformations/{transformation_id}/run
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' has been started"
}
Pause dbt Transformation Deprecated
Pauses dbt transformation.
NOTE: This endpoint is deprecated, use Modify dbt Transformation instead.
Request
POST https://api.fivetran.com/v1/dbt/transformations/{transformation_id}/pause
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' has been paused"
}
Resume dbt Transformation Deprecated
Resumes the specified dbt Transformation.
NOTE: This endpoint is deprecated, use Modify dbt Transformation instead.
Request
POST https://api.fivetran.com/v1/dbt/transformations/{transformation_id}/resume
Path parameters
Name | Description |
---|---|
transformation_id | The unique identifier for the dbt Transformation within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Transformation with id 'transformation_id' has been resumed"
}