Skip to content
Adaption
Get started
API Reference
Datasets

Get the processing status of a dataset

GET/api/v1/datasets/{dataset_id}/status

Get the processing status of a dataset

Path ParametersExpand Collapse
dataset_id: string
ReturnsExpand Collapse
dataset_id: string

Dataset ID

error: object { message }

Error details if the dataset failed. Null otherwise.

message: string

Error message

progress: object { percent, processed_rows, total_rows }

Processing progress. Null when no run is active.

percent: number

Progress percentage (0-100)

processed_rows: number

Number of rows processed so far

total_rows: number

Total rows to process (samples_to_process or row_count)

row_count: number

Number of rows in the dataset

status: "pending" or "running" or "succeeded" or "failed"

Current processing status

One of the following:
"pending"
"running"
"succeeded"
"failed"

Get the processing status of a dataset

curl https://api.adaptionlabs.ai/api/v1/datasets/$DATASET_ID/status \
    -H "Authorization: Bearer $ADAPTION_API_KEY"
{
  "dataset_id": "dataset_id",
  "error": {
    "message": "message"
  },
  "progress": {
    "percent": 0,
    "processed_rows": 0,
    "total_rows": 0
  },
  "row_count": 0,
  "status": "pending"
}
Returns Examples
{
  "dataset_id": "dataset_id",
  "error": {
    "message": "message"
  },
  "progress": {
    "percent": 0,
    "processed_rows": 0,
    "total_rows": 0
  },
  "row_count": 0,
  "status": "pending"
}