Skip to main content
GET
/
api
/
dataframer
/
runs
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const runs = await client.dataframer.runs.list();

console.log(runs);
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spec_id": "<string>",
    "spec_name": "<string>",
    "spec_version": 123,
    "dataset_id": "<string>",
    "dataset_name": "<string>",
    "number_of_samples": -1,
    "status": "PENDING",
    "status_display": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_by_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "duration_seconds": 123,
    "trace": {}
  }
]

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Response

List of runs

id
string<uuid>
spec_id
string
Minimum string length: 1
spec_name
string
Minimum string length: 1
spec_version
integer
dataset_id
string
Minimum string length: 1
dataset_name
string
Minimum string length: 1
number_of_samples
integer
Required range: -2147483648 <= x <= 2147483647
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED,
CANCELED
status_display
string
Minimum string length: 1
started_at
string<date-time> | null
completed_at
string<date-time> | null
created_by_name
string
Minimum string length: 1
created_at
string<date-time>
duration_seconds
number
trace
Trace · object