Skip to main content
GET
Get a dataset

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Path Parameters

id
string<uuid>
required

Dataset ID

Response

The dataset

A dataset and the state of its rows

id
string<uuid>
required
name
string
required
spec
object
required
status
enum<string>
required

empty: no rows yet; populating: a run is adding rows; ready: rows stand; failed or cancelled: how the latest run ended

Available options:
empty,
populating,
ready,
failed,
cancelled
target_rows
integer
required

Rows a populate fills to

row_count
integer
required
run
object | null
required

The latest run, however it ended; null when the dataset never ran

created_at
string<date-time>
required