get-dataset-items
Read-onlyIdempotent
Retrieve dataset items with pagination, sorting, and field selection. Use dot notation for nested fields and skip empty items with clean=true.
Instructions
Retrieve dataset items with pagination, sorting, and field selection. For nested fields use dot notation (e.g., fields="metadata.url") — the server auto-flattens parent prefixes. Defaults limit to 20. Use clean=true to skip empty items and hidden fields.
The results will include items along with pagination info (limit, offset) and total count.
USAGE:
Use when you need to read data from a dataset (all items or only selected fields).
USAGE EXAMPLES:
user_input: Get first 20 items from dataset abd123
user_input: Get only metadata.url and title from dataset username~my-dataset
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datasetId | Yes | Dataset ID or username~dataset-name. | |
| clean | No | If true, returns only non-empty items and skips hidden fields (starting with #). Shortcut for skipHidden=true and skipEmpty=true. | |
| offset | No | Number of items to skip at the start. Default is 0. | |
| limit | No | Maximum number of items to return. Defaults to 20. | |
| fields | No | Comma-separated list of fields to include in results. Fields in output are sorted as specified. Use dot notation for nested objects (e.g. "metadata.url"); the server auto-flattens parent prefixes. | |
| omit | No | Comma-separated list of fields to exclude from results. | |
| desc | No | If true, results are returned in reverse order (newest to oldest). | |
| flatten | No | Comma-separated list of fields to flatten (e.g. flatten="metadata" turns {"metadata":{"url":"x"}} into {"metadata.url":"x"}). Normally derived automatically from dot-notation in `fields`; specify only as a diagnostic override. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datasetId | Yes | Dataset ID | |
| items | Yes | Dataset items | |
| itemCount | Yes | Number of items returned | |
| totalItemCount | No | Total items in dataset | |
| offset | No | Offset used for pagination | |
| limit | No | Limit used for pagination |