Describe a Dataset
describe_datasetThe full schema of one dataset: every column (type, role, unit, value range, what a NULL means), the exact filters with their valid values (the keys query_dataset and aggregate accept), how the code columns join to the lookup tables (foreign_keys), example queries, usage notes, limitations, and null semantics. key_metric names the headline figure most answers want. Per column, key_metric_grain_contributor marks a category the headline figure is only comparable within (pin it or group by it) and metric_component marks the numerator and denominator of a rate. recommended_query is a safe default query (headline figure, the filters to pin, required single-value choices) plus a ranking recipe for top or bottom N. filter_hints lists paired filters. non_additive lists columns whose rows overlap, so summing across them double counts; value_implications lists values that imply another column's value. year_meaning, when set, says what year labels when it is not when the figures were measured. pooled_rates lists rates whose figure for several rows is SUM(numerator) / SUM(denominator) (aggregate with agg='weighted_rate'), not an average of the rows' rates. series_breaks lists years from which figures are not comparable with earlier years (each with its reason; metrics, when present, limits it to those columns), so the step into such a year is not a trend. Each category filter carries has_total and requires_single_value. verbosity='schema' drops the prose (descriptions, usage, limitations, examples) for a much smaller payload that still has everything needed to build a query; the limitations prose in the default 'full' carries the caveats. An unknown dataset returns an error listing the available ones with a 'did you mean'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | Dataset name, e.g. 'act_scores' (the last part of a key from list_datasets or search_datasets). The full key, e.g. 'education/gosa/act_scores', also works and sets main_topic. | |
| verbosity | No | 'full' (default) or 'schema' (drops the prose; keeps columns, filters and valid values, key_metric, and recommended_query). | full |
| main_topic | No | Subject area: 'education' (the default), 'census', or 'immigration'. A dataset's key starts with it. | education |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||