Skip to main content
Return the dataset name, project, profile, and creation time. Use the fields or items endpoints to inspect its contents.

Signature

Method signature on client.datasets:

Parameters

string
required
Dataset ID with prefix ds..

Returns

Promise<Dataset> A dataset within a project.
DatasetId
required
Dataset ID with prefix ds..
ProjectId
required
Project ID with prefix pp..
string
required
Name of the dataset.
boolean
required
Whether the dataset is hidden from ordinary dataset lists.
DatasetProfileStamp | null
required
Profile used to create the dataset fields, or null for a dataset without a profile.
string
required
Time the dataset was created, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /datasets/{datasetId}.