Describe an ILOSTAT dataset
ilostat_describe_indicatorExplain one ILOSTAT dataset before comparing numbers: its definition, unit and multiplier, frequency variants and coverage, the sex and breakdown codes in use across its frequencies (the total code of each breakdown marked), the reference areas it covers, whether it carries World/regional/income-group aggregates, and how its observations are classed as reported, modelled, or projected. Accepts a dataset ID (UNE_DEAP_SEX_AGE_RT_A) or a bare indicator code (UNE_DEAP_SEX_AGE_RT), which describes every frequency. An unknown code returns found: false with guidance.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"dataset_id": "<dataset_id>"
},
"name": "ilostat_describe_indicator"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | One dataset ID (indicator code plus _A, _Q, or _M, e.g. UNE_DEAP_SEX_AGE_RT_A) or a bare indicator code (UNE_DEAP_SEX_AGE_RT), as ilostat_search_indicators returns them. Case-insensitive; a DF_ prefix (the SDMX dataflow form) is stripped. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The most related indicators listed. | |
| unit | No | Unit of the values, already in the multiplier scale; absent when unresolved. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | False when no dataset or indicator has the code. | |
| label | No | Indicator label as ILOSTAT publishes it. | |
| shown | No | Related indicators listed. | |
| notice | No | Where to find breakdown codes and units when the structure service did not supply them, and how to list every related indicator when the list is cut — whichever apply, joined. | |
| measure | No | Measure (the quantity measured, shared by breakdown variants) code and label. | |
| subject | No | Subject code and label. | |
| database | No | Source database code and label. | |
| datasets | No | Every frequency variant of the indicator, annual first. | |
| guidance | No | On a miss: how to find a valid dataset ID. | |
| indicator | No | Indicator code. | |
| ref_areas | No | Reference areas the indicator covers across its frequencies, from ILOSTAT's structure service; absent when structure_status is unavailable. | |
| truncated | No | True when related_datasets lists fewer than related_total. | |
| basis_rule | No | How observations are classed reported, modelled_estimate, or projection. | |
| breakdowns | No | Breakdown codes in use, from ILOSTAT's structure service; absent when structure_status is unavailable. | |
| dataset_id | No | The dataset requested, when a dataset ID (not a bare indicator code) was given. | |
| definition | No | ILOSTAT definition of the indicator, HTML stripped; links kept as "text (url)". | |
| attribution | No | Citation to keep with any use of the data. | |
| catalog_as_of | No | ISO timestamp the catalog was last confirmed current. | |
| default_slice | No | The dataset's total codes from its default view — the slice ilostat_compare_geographies uses when sex, classif1, or classif2 is omitted; a breakdown with no total (deciles) is left out. | |
| related_total | No | How many other indicators share this measure. ilostat_search_indicators with measure set to measure.code lists them all. | |
| has_aggregates | No | Whether the requested dataset (or, for an indicator code, any of its datasets) carries World, regional, or income-group rows. | |
| related_datasets | No | The first 20 other indicators sharing this measure under other breakdowns, by code; related_total counts all of them. | |
| structure_status | No | unavailable when ILOSTAT's structure service has no entry for the indicator or cannot be reached; breakdowns, default_slice, unit, and ref_areas are then absent. |