Skip to main content
GET
/
api
/
v1
/
transformations
cURL
curl --request GET \
  --url https://api.nekt.ai/api/v1/transformations/ \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "slug": "<string>",
      "deleted": true,
      "active": true,
      "status": "<string>",
      "deploy_failed": true,
      "deploy_failed_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "settings_timezone": "Africa/Abidjan",
      "last_run": "<string>",
      "input_tables": [
        "<string>"
      ],
      "input_volumes": [
        "<string>"
      ],
      "output_tables": [
        "<string>"
      ],
      "created_by": 123,
      "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,
      "settings_number_of_retries": 1073741823,
      "settings_retry_delay_seconds": 1073741823,
      "settings_max_consecutive_failures": 1073741824,
      "delta_log_retention_duration": -1,
      "python_notebook_image_version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "python_execution_cpu": -1,
      "python_execution_memory": -1
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Query Parameters

​
created_at__gt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__lte
string<date-time>
​
created_by
integer
​
last_run_status
enum<string>[]

Multiple values may be separated by commas.

  • pending_events - PENDING_EVENTS
  • queued - QUEUED
  • running - RUNNING
  • success - SUCCESS
  • failed - FAILED
  • cancelling - CANCELLING
  • canceled - CANCELED
Available options:
canceled,
cancelling,
failed,
pending_events,
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.

​
search
string

A search term.

​
slug
string
​
sort
enum<string>[]

Ordering

  • slug - Slug
  • -slug - Slug (descending)
  • output_table_name - Output table name
  • -output_table_name - Output table name (descending)
  • description - Description
  • -description - Description (descending)
  • type - Type
  • -type - Type (descending)
  • created_by - Created by
  • -created_by - Created by (descending)
  • created_at - Created at
  • -created_at - Created at (descending)
  • updated_at - Updated at
  • -updated_at - Updated at (descending)
Available options:
-created_at,
-created_by,
-description,
-output_table_name,
-slug,
-type,
-updated_at,
created_at,
created_by,
description,
output_table_name,
slug,
type,
updated_at
​
status
enum<string>[]

Multiple values may be separated by commas.

  • pending_events - PENDING_EVENTS
  • preparing - PREPARING
  • queued - QUEUED
  • running - RUNNING
  • cancelling - CANCELLING
  • idle - IDLE
  • inactive - INACTIVE
  • deploy_failed - DEPLOY_FAILED
Available options:
cancelling,
deploy_failed,
idle,
inactive,
pending_events,
preparing,
queued,
running
​
tag
string
​
type
enum<string>[]

Multiple values may be separated by commas.

  • pyspark - PySpark
  • sql - SQL
  • scd_type_2 - SCD type 2
  • python - Python
Available options:
pyspark,
python,
scd_type_2,
sql
​
updated_at__gt
string<date-time>
​
updated_at__gte
string<date-time>
​
updated_at__lt
string<date-time>
​
updated_at__lte
string<date-time>

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

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

​
previous
string<uri> | null
Example:

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