Retrieve dbt Transformation Details

Returns a dbt Transformation details if a valid identifier was provided.

Request schema

Path parameters

transformationId

stringrequired

The unique identifier for the dbt Transformation within the Fivetran system.

example:

transformation_id

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/dbt/transformations/transformation_id

GET /v1/dbt/transformations/transformation_id HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the dbt Model within the Fivetran system.

status

stringrequired

The status of dbt Transformation.

enum:

"SUCCEEDED""RUNNING""FAILED""PENDING"

schedule

object

interval

integer

Interval.

format:

int32

example:

schedule_type

stringrequired

Schedule type

enum:

"INTEGRATED""TIME_OF_DAY""INTERVAL"

days_of_week

array

Days of week

example:

MONDAY,FRIDAY

type:

string

time_of_day

string

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'

example:

14:00

paused

boolean

The field indicates whether transformation is in paused state.

last_run

string

The timestamp of last dbt Transformation run.

format:

date-time

example:

2023-12-01T15:43:29.013729Z

output_model_name

string

The dbt Model name.

example:

output_model_name

dbt_project_id

string

The unique identifier for the dbt Project within the Fivetran system.

example:

dbt_project_id

dbt_model_id

string

The unique identifier for the dbt Model within the Fivetran system.

example:

dbt_model_id

next_run

string

The timestamp of next dbt Transformation run.

format:

date-time

example:

2023-01-02T00:00:00.743708Z

created_at

string

format:

date-time

run_tests

boolean

The field indicates whether the tests have been configured for dbt Transformation.

example:

true

model_ids

array

Identifiers of related models

example:

model_id_1,model_id_2,...

type:

string

connector_ids

array

Identifiers of related connectors

example:

connector_id_1,connector_id_2,...

type:

string

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "string",
    "status": "SUCCEEDED",
    "schedule": {
      "interval": 60,
      "schedule_type": "TIME_OF_DAY",
      "days_of_week": [
        "MONDAY",
        "FRIDAY"
      ],
      "time_of_day": "14:00"
    },
    "paused": false,
    "last_run": "2023-12-01T15:43:29.013729Z",
    "output_model_name": "output_model_name",
    "dbt_project_id": "dbt_project_id",
    "dbt_model_id": "dbt_model_id",
    "next_run": "2023-01-02T00:00:00.743708Z",
    "created_at": "2019-08-24T14:15:22Z",
    "run_tests": true,
    "model_ids": [
      "model_id_1",
      "model_id_2",
      "..."
    ],
    "connector_ids": [
      "connector_id_1",
      "connector_id_2",
      "..."
    ]
  }
}