describe_dataset
Retrieve filterable dimensions, returnable measures, units, source, and insurance framework break info for a dataset. Use before get_data to see valid filter keys and measure aliases.
Instructions
Describe a dataset's filterable dimensions, returnable measures, units, source, and (for insurance) framework break info.
Use this before calling get_data on a new dataset — it tells you the valid filter keys ('institution', 'sector', 'data_item'), the valid enumerated filter values ('cba', 'major_banks'), the measure aliases ('cet1_ratio', 'total_capital'), and the canonical source URL.
For insurance datasets, the response includes a framework block
documenting the Q3-2023 AASB-17 break.
Returns: DatasetDetail with id, name, description, period_coverage, list of dimensions, list of measures, source_url, download_url, and optional framework info.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | Curated dataset ID. Use search_datasets() to discover or list_curated() to enumerate. Case-insensitive. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| description | Yes | ||
| is_curated | Yes | ||
| update_frequency | No | ||
| period_coverage | No | ||
| dimensions | No | ||
| measures | No | ||
| source_url | Yes | ||
| download_url | No | ||
| framework | No |