listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.
Signature
Method signatures onclient.datasets:
Parameters
listAllItems()
string
required
Dataset ID with prefix
ds..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
listItemsPage()
string
required
Dataset ID with prefix
ds..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
Returns
listAllItems() result
AsyncGenerator<DatasetItem>
Yields one item at a time. The fields below describe each yielded item.
An item in a dataset.
DatasetItemId
required
Dataset item ID with prefix
di..number
required
One-based position of this item in the dataset.
string
required
Time the dataset item was created, as an ISO 8601 timestamp.
string | null
required
ID of the current submission for this item, or null when it has none.
listItemsPage() result
Promise<{ items: DatasetItem[]; pagination: Pagination }>
DatasetItem[]
required
Run items in this page.
Pagination
required
Pagination information for this page.
Errors
HTTP errors throwPotatoApiError. The endpoint documents these error responses:
HTTP endpoint:
GET /datasets/{datasetId}/items.