Skip to main content
GET
/
api
/
dataframer
/
transform-jobs
Python
import os
from dataframer import Dataframer

client = Dataframer(
    api_key=os.environ.get("DATAFRAMER_API_KEY"),  # This is the default and can be omitted
)
transform_jobs = client.dataframer.transform_jobs.list()
print(transform_jobs)
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "PENDING",
    "datasets_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_name": "<string>",
    "detection_method": "<string>",
    "pii_types": [
      "<string>"
    ],
    "metrics_json": {},
    "created_by_email": "[email protected]",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Response

List of transform jobs

​
id
string<uuid>

Unique identifier for the transform job.

​
name
string

Human-readable name for this job.

​
status
enum<string>

Current status of the transform job.

Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED
​
datasets_id
string<uuid>

UUID of the seed dataset being transformed.

​
dataset_name
string

Name of the seed dataset.

​
detection_method
string

Entity detection method used.

​
pii_types
string[]

List of PII/PHI entity types being detected.

​
metrics_json
object

Transform results (populated once SUCCEEDED).

​
created_by_email
string<email>

Email of the user who created this job.

​
started_at
string<date-time> | null

When processing started.

​
completed_at
string<date-time> | null

When the job completed.

​
created_at
string<date-time>

When the job was created.