Skip to content
sgp
API Reference

Datasets

Create a dataset
datasets.create(DatasetCreateParams**kwargs) -> Dataset
POST/v5/datasets
List datasets
datasets.list(DatasetListParams**kwargs) -> SyncCursorPage[Dataset]
GET/v5/datasets
Archive a dataset
datasets.archive(strdataset_id) -> DatasetArchiveResponse
DELETE/v5/datasets/{dataset_id}
Update or restore a dataset
datasets.update(strdataset_id, DatasetUpdateParams**kwargs) -> Dataset
PATCH/v5/datasets/{dataset_id}
Get a dataset
datasets.retrieve(strdataset_id, DatasetRetrieveParams**kwargs) -> Dataset
GET/v5/datasets/{dataset_id}
ModelsExpand Collapse
class Dataset: …
id: str

The unique identifier of the entity.

created_at: datetime

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

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
current_version_num: int
name: str
tags: Optional[List[str]]

The tags associated with the entity

archived_at: Optional[datetime]

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

formatdate-time
description: Optional[str]
object: Optional[Literal["dataset"]]
class DatasetArchiveResponse: …
id: str
deleted: bool
object: Optional[Literal["dataset"]]