Skip to main content
GET
/
datasets
Get Datasets
curl --request GET \
  --url https://api.serial.io/datasets \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order": 123,
    "data_type": "PARAMETRIC_QUANTITATIVE",
    "created_at": "2023-11-07T05:31:56Z",
    "process_revision": 123,
    "lsl": 123,
    "usl": 123,
    "unit": "<string>",
    "child_component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_value": "<any>",
    "is_active": true,
    "values": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Query Parameters

​
name
string

Get datasets by name (Case & Space sensitive, must be an exact match)

​
process_id
string

Get datasets by associated processes

​
type
string

Get datasets by their types (LINK, TEXT, NUMERICAL, BOOLEAN, IMAGE, FILE)

Response

200 - application/json

OK

​
id
string<uuid>
required

Database id for the dataset

​
name
string
required

User facing name for the dataset

​
process_id
string<uuid>
required

Process id associated with the dataset

​
data_type
enum<string>
required
Available options:
PARAMETRIC_QUANTITATIVE,
PARAMETRIC_QUALITATIVE,
CHECKBOX,
LINK,
IMAGE,
FILE,
UID
​
created_at
string<date-time>
required
​
process_revision
number
required
​
order
number

Order in which the dataset shows up relative to others

​
lsl
number
​
usl
number
​
unit
string
​
child_component_id
string<uuid>
​
expected_value
any
​
is_active
boolean
​
values
string[]

Used for property datasets, is a LRU cache of used values