List GHO Dimension Values
who_list_dimension_valuesList valid codes and labels for a WHO GHO dimension type such as COUNTRY, REGION, SEX, WORLDBANKINCOMEGROUP, or AGEGROUP. Use this to discover valid filter values before calling who_query_indicator_data, or to confirm the correct ISO code for a country. Use who_list_dimensions to discover all available dimension type codes. Results are paged in a deterministic order — narrow hierarchical dimensions with parent_code (e.g. the countries in one WHO region), and page the rest with offset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of values to return per page. Default 100, max 500. | |
| offset | No | Zero-based offset into the values for this dimension and filter. Default 0. Read hasMore and nextOffset from the response to continue paging. An offset at or beyond totalCount returns an empty values array, not an error. | |
| dimension | Yes | Dimension type code. Use who_list_dimensions to discover all available codes. Common values: COUNTRY, REGION, SEX, WORLDBANKINCOMEGROUP, AGEGROUP. | |
| parent_code | No | Restrict results to values under one parent, e.g. dimension="COUNTRY" with parent_code="EUR" for the countries in the WHO European Region. Only hierarchical dimensions carry a parent; a filter that matches nothing returns an empty page, not an error. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Present when values were withheld, the parent_code filter matched nothing, or the requested offset ran past the end. Explains what to do next. | |
| offset | No | Zero-based offset this page started at. | |
| values | No | Valid values for this dimension type, for the requested page. | |
| hasMore | No | True when more values remain beyond this page. Pair with nextOffset to continue. | |
| pageInfo | No | Human-readable page position, e.g. "offset 0, showing 100 of 234". Use to construct the next offset. | |
| dimension | No | The requested dimension type code. | |
| nextOffset | No | Offset to request for the next page. Absent when this page reached the end of the values. | |
| totalCount | No | Total values for this dimension and filter, before the limit is applied. |