Skip to content
Adaption
Get started
API Reference
Datasets

List datasets

client.datasets.list(DatasetListParams { created_after, created_before, cursor, 5 more } query?, RequestOptionsoptions?): DatasetListResponse { datasets, next_cursor }
GET/api/v1/datasets

List datasets

ParametersExpand Collapse
query: DatasetListParams { created_after, created_before, cursor, 5 more }
created_after?: string

ISO 8601 datetime — datasets created after this time.

created_before?: string

ISO 8601 datetime — datasets created before this time.

cursor?: string

Cursor from the previous response next_cursor field.

limit?: number

Number of results (max 100, default 20). Used with cursor pagination.

q?: string

Search by dataset name (case-insensitive contains).

sort?: string

Sort field: created_at | updated_at | name (default: created_at).

sort_direction?: string

Sort direction: asc | desc (default: desc).

status?: string

Filter by status: pending | running | succeeded | failed

ReturnsExpand Collapse
DatasetListResponse { datasets, next_cursor }
datasets: Array<Dataset>

Page of datasets

created_at: string

Timestamp when the dataset was created

formatdate-time
dataset_id: string

Dataset ID

status: "pending" | "running" | "succeeded" | "failed"

Dataset status

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

Last updated timestamp

formatdate-time
description?: string | null

Auto-generated description of the dataset contents

name?: string | null

Dataset name

row_count?: number | null

Total number of rows

next_cursor?: string | null

Cursor for the next page. Null when no more results.

List datasets

import Adaption from 'adaption';

const client = new Adaption({
  apiKey: process.env['ADAPTION_API_KEY'], // This is the default and can be omitted
});

const datasets = await client.datasets.list();

console.log(datasets.datasets);
{
  "datasets": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "dataset_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "pending",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "name": "My training data",
      "row_count": 1000
    }
  ],
  "next_cursor": "550e8400-e29b-41d4-a716-446655440000"
}
Returns Examples
{
  "datasets": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "dataset_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "pending",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "name": "My training data",
      "row_count": 1000
    }
  ],
  "next_cursor": "550e8400-e29b-41d4-a716-446655440000"
}