Get dataset items
get-dataset-itemsFetch paginated items from a dataset, selecting only needed fields using dot notation. Optionally sort, filter empty items, and exclude hidden fields.
Instructions
Retrieve dataset items with pagination, sorting, and field selection. Items can be large; when you only need specific columns, pass fields to reduce response size (use get-dataset first if you don't know the field names). 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
| Name | Required | Description | Default |
|---|---|---|---|
| desc | No | If true, results are returned in reverse order (newest to oldest). | |
| omit | No | Comma-separated list of fields to exclude from results. | |
| clean | No | If true, returns only non-empty items and skips hidden fields (starting with #). Shortcut for skipHidden=true and skipEmpty=true. | |
| 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. | |
| offset | No | Number of items to skip at the start. Default is 0. | |
| 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. | |
| datasetId | Yes | Dataset ID or username~dataset-name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | Dataset items | |
| limit | Yes | Limit used for pagination | |
| offset | Yes | Offset used for pagination | |
| summary | Yes | Summary of the result | |
| nextStep | Yes | One follow-up action with tool name | |
| datasetId | Yes | Dataset ID | |
| itemCount | Yes | Number of items returned | |
| totalItemCount | Yes | Total items in dataset | |
| apifyConsoleUrl | No | Personalized Apify Console link to the dataset; present only for Console sessions |