Retrieve Quickstart Transformations

Returns a list of all Quickstart transformations within your Fivetran account or within the specified Quickstart package in your account.

Request schema

Query parameters

package_id

string

The unique identifier for the Quickstart package within the Fivetran system.

example:

package_id

cursor

string

Paging cursor, read more about pagination

example:

qq34ja5jhl51hl

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

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/qdm/transformations

GET /v1/qdm/transformations?package_id=package_id&cursor=qq34ja5jhl51hl&limit=100 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

items

arrayrequired

The collection of returned items

stringrequired

The unique identifier for the Quickstart Transformation within the Fivetran system. Quickstart Transformation ids match with the Quickstart Model ids.

example:

transformation_id

name

stringrequired

The Quickstart Transformation name.

example:

transformation_name

status

stringrequired

The status of Quickstart Transformation.

enum:

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

paused

booleanrequired

The field indicates whether the Quickstart Transformation is in paused state.

last_run

string

The last transformations run time.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

run_tests

booleanrequired

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

example:

true

package_id

stringrequired

The unique identifier for the Quickstart Package within the Fivetran system.

example:

package_id

next_run

string

The nearest predicted time when this model can start again.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

nextCursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "items": [
      {
        "id": "transformation_id",
        "name": "transformation_name",
        "status": "RUNNING",
        "paused": false,
        "last_run": "2023-08-20T10:15:20.677566Z",
        "run_tests": true,
        "package_id": "package_id",
        "next_run": "2023-08-20T10:15:20.677566Z"
      }
    ],
    "nextCursor": "cursor_value"
  }
}