get_subdataset_by_path_v1_datasets__provider___dataset___subdata
Retrieve subdataset metadata and paginated data rows. Use cursor for efficient keyset pagination and optional parameters to filter, sort, or group.
Instructions
GET /v1/datasets/{provider}/{dataset}/{subdataset} (public) — Get Subdataset By Path — Get subdataset with inline data.
Returns subdataset metadata with paginated data rows.
Pagination:
Use
cursorfor keyset pagination (efficient for large datasets with views)The response includes
next_cursorif more data is availablePass the
next_cursorvalue ascursorin the next request
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| provider | Yes | ||
| dataset | Yes | ||
| subdataset | Yes | ||
| limit | No | ||
| offset | No | ||
| cursor | No | Cursor for keyset pagination (from next_cursor in previous response) | |
| view | No | View: 'flat', 'timeseries', or custom grouping params | |
| expand | No | Comma-separated fields to expand (e.g., 'area,item') | |
| fields | No | Comma-separated columns to include (e.g., 'date,value') | |
| sort | No | Column to sort by. Prefix with - for descending (e.g., 'date', '-year') | |
| group_by | No | Column to group by | |
| nest_fields | No | Comma-separated columns to include in nested items | |
| nest_field | No | Name for nested array (default: 'items') | |
| sort_nested | No | Column to sort nested items by | |
| aggregate | No | Comma-separated aggregate expressions: avg(score),count(*). Supported functions: count, sum, avg, min, max, count_distinct | |
| include_sources | No | Include source attribution columns in response data | |
| response_format | No | Response format: 'columnar' (default, compact array-of-arrays) or 'objects' (array-of-dicts) | |
| debug | No | Include debug info (query echo, generated SQL) in response |