Skip to content
sgp
API Reference

Datasets

Create a dataset
client.datasets.create(DatasetCreateParams { data, name, description, 2 more } body, RequestOptionsoptions?): Dataset { id, created_at, created_by, 6 more }
POST/v5/datasets
List datasets
client.datasets.list(DatasetListParams { ending_before, include_archived, limit, 5 more } query?, RequestOptionsoptions?): CursorPage<Dataset { id, created_at, created_by, 6 more } >
GET/v5/datasets
Archive a dataset
client.datasets.archive(stringdatasetID, RequestOptionsoptions?): DatasetArchiveResponse { id, deleted, object }
DELETE/v5/datasets/{dataset_id}
Update or restore a dataset
client.datasets.update(stringdatasetID, DatasetUpdateParams { dataset } params, RequestOptionsoptions?): Dataset { id, created_at, created_by, 6 more }
PATCH/v5/datasets/{dataset_id}
Get a dataset
client.datasets.retrieve(stringdatasetID, DatasetRetrieveParams { include_archived } query?, RequestOptionsoptions?): Dataset { id, created_at, created_by, 6 more }
GET/v5/datasets/{dataset_id}
ModelsExpand Collapse
Dataset { id, created_at, created_by, 6 more }
id: string

The unique identifier of the entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
current_version_num: number
name: string
tags: Array<string> | null

The tags associated with the entity

archived_at?: string

The date and time when the entity was archived in ISO format.

formatdate-time
description?: string
object?: "dataset"
DatasetArchiveResponse { id, deleted, object }
id: string
deleted: boolean
object?: "dataset"