Jobs REST API Guide

Get async job details for a job id

Get async job details for a job id

get

/v3/jobs/{job_id}

Authorizations

Path parameters

job_idstring uuidrequired

job id path parameter

Query parameters

verboseboolean

flag for extras in response

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/jobs/{job_id}' \
  --header 'Authorization: Bearer <token>'

200

400

401

404

500

200

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "name": "Ingestion dataset Upload",
    "info": {
      "resource_type": "DATASET",
      "resource_name": "bank_churn",
      "project_name": "bank_churn",
      "resource": {
        "id": "c97cd455-1e64-4e79-bd86-7bd399505678",
        "name": "bank_churn"
      },
      "model": {
        "id": "c97cd455-1e64-4e79-bd86-7bd399505678",
        "name": "bank_churn",
        "version": "v1"
      },
      "project": {
        "id": "e3a4d78e-f294-4d5c-b28a-129164588a32",
        "name": "bank_churn"
      }
    },
    "id": "e9a2a782-1db4-4bb8-8db0-3fa5a278c068",
    "status": "SUCCESS",
    "progress": 100,
    "error_message": null,
    "error_reason": null,
    "extras": {
      "3f5025e5-1d2f-4b0f-a955-b8cd4e43d2e8": {
        "status": "SUCCESS",
        "result": {
          "result": {
            "__org": "s3bucket",
            "s3_key": "s3bucket//s3bucket/first_project/bank_churn/small_dataset.csv",
            "__dataset": "bank_churn",
            "__project": "first_project",
            "file_type": ".csv",
            "s3_bucket": "fiddler-bucket-staging",
            "cleaned_s3_key": "s3bucket//s3bucket/first_project/bank_churn/cleaned/small_dataset.csv",
            "cleaned_ch_table": "s3bucket_first_project__dataset__bank_churn",
            "violations_s3_key": "s3bucket//s3bucket/first_project/bank_churn/violations/small_dataset.csv",
            "violations_ch_table": null
          }
        },
        "error_message": null
      },
      "e36d1cf2-766f-4705-8269-b6f93bf1ca14": {
        "status": "SUCCESS",
        "result": {
          "result": "Success"
        },
        "error_message": null
      }
    }
  }
}

Success, Details of a job

Get details of all background/async jobs

Get details of all background/async jobs

get

/v3/jobs

Authorizations

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/jobs' \
  --header 'Authorization: Bearer <token>'

200

400

401

404

500

200

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "name": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "info": {
          "resource_type": "DATASET",
          "resource_name": "text",
          "project_name": "text",
          "resource": {
            "id": "text",
            "name": "text"
          },
          "project": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          },
          "model": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "version": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "status": "PENDING",
        "created_at": "2025-02-06T09:51:10.212Z",
        "updated_at": "2025-02-06T09:51:10.212Z",
        "started_at": "2025-02-06T09:51:10.212Z",
        "completed_at": "2025-02-06T09:51:10.212Z"
      }
    ]
  }
}

Success, Details of all background/async jobs