GET
/
api
/
v1
/
transformations
curl --request GET \
  --url https://api.nekt.ai/api/v1/transformations/ \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "pipeline_slug": "<string>",
      "pipeline_active": true,
      "pipeline_current_status": "<string>",
      "output_table_name": "<string>",
      "output_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "output_layer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>"
      },
      "last_run": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "status": "queued"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "picture": "<string>",
        "role": "<string>",
        "functional_area": "data_analytics",
        "other_functional_area": "<string>",
        "date_joined": "2023-11-07T05:31:56Z",
        "last_login": "2023-11-07T05:31:56Z",
        "is_active": false,
        "permission_groups": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "description": "<string>"
          }
        ]
      },
      "description": "<string>",
      "code": "<string>",
      "dependencies": [
        "<string>"
      ],
      "add_apache_sedona": true,
      "spark_driver_cores": 1073741824,
      "spark_driver_memory": 1073741825,
      "spark_executor_cores": 1073741824,
      "spark_executor_memory": 1073741825,
      "spark_executor_instances": 1073741824,
      "spark_executor_disk": 1073741833,
      "spark_execution_timeout_minutes": 1073741831,
      "pipeline_number_of_retries": 1073741823,
      "pipeline_retry_delay_seconds": 1073741823,
      "pipeline_max_consecutive_failures": 1073741824,
      "delta_log_retention_duration": -1,
      "draft_only": true,
      "current_draft": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "needs_validation",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "created_by": {
          "id": 123,
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "picture": "<string>",
          "role": "<string>",
          "functional_area": "data_analytics",
          "other_functional_area": "<string>",
          "date_joined": "2023-11-07T05:31:56Z",
          "last_login": "2023-11-07T05:31:56Z",
          "is_active": true,
          "permission_groups": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "description": "<string>"
            }
          ]
        }
      },
      "triggers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "type": "manual",
          "cron_expression": "<string>",
          "cron_timezone": "Africa/Abidjan",
          "events": [
            "<string>"
          ],
          "event_rule": "any"
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: {api_token}'

Query Parameters

last_run_status
enum<string>[]

Multiple values may be separated by commas.

  • queued - QUEUED
  • running - RUNNING
  • success - SUCCESS
  • failed - FAILED
  • cancelling - CANCELLING
  • canceled - CANCELED
Available options:
canceled,
cancelling,
failed,
queued,
running,
success
output_table_name
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

pipeline_current_status
enum<string>[]

Multiple values may be separated by commas.

  • preparing - PREPARING
  • queued - QUEUED
  • running - RUNNING
  • cancelling - CANCELLING
  • idle - IDLE
  • inactive - INACTIVE
Available options:
cancelling,
idle,
inactive,
preparing,
queued,
running
pipeline_slug
string

A search term.

sort
enum<string>[]

Ordering

  • pipeline_slug - Pipeline slug
  • -pipeline_slug - Pipeline slug (descending)
  • output_table_name - Output table name
  • -output_table_name - Output table name (descending)
  • description - Description
  • -description - Description (descending)
Available options:
-description,
-output_table_name,
-pipeline_slug,
description,
output_table_name,
pipeline_slug

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string | null
Example:

"http://api.example.org/accounts/?page=2"