List CDC Catalog Vocabulary
cdc_list_catalog_vocabularyList the controlled vocabularies cdc_discover_datasets' category and tags filters are matched against — every domain category and domain tag the CDC catalog publishes, each with the number of entries carrying it. Call it before filtering a search: a value the catalog does not carry matches nothing and returns an empty page, which is indistinguishable from a real value with no results. All 55 categories come back whole; the tag vocabulary runs to roughly 1,600 values, so tags are ranked by entry count and returned one page at a time via tag_limit and tag_offset. Pass filter to narrow both vocabularies to the values whose words contain it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | CDC Socrata host to read the vocabulary from. "data.cdc.gov" (default) and "chronicdata.cdc.gov" front the same catalog and publish the same vocabulary, so this selects which host answers, never which values exist. | data.cdc.gov |
| filter | No | Narrow both vocabularies to the values related to this text. A value matches when every word of the filter appears inside one of its words ("vaccin" reaches "Vaccinations" and "covid-19 vaccination"), or when the whole value appears in the filter. Matching is not fuzzy — a misspelling returns nothing rather than a guess — and a filter under three letters is ignored. | |
| tag_limit | No | Tags to return in this call (default 50, max 500). Tags are ranked by entry count, so the default page is the most-used end of the vocabulary; the response reports how many matched and a nextOffset while more remain. Categories are never paged — all 55 arrive whole. | |
| tag_offset | No | Index of the first tag to return, for continuing past a previous call (default 0). Ranking is stable, so tag_offset plus tag_limit walks the vocabulary without gaps or repeats. An offset at or past the number of matching tags returns an empty tag list rather than an error. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The tag_limit that bounded this response. | |
| tags | No | The requested window of domain tags, ranked by entry count. Pass values to cdc_discover_datasets' tags input; tags union there, so each one added widens the result set. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Number of tags returned in this response. | |
| domain | No | CDC Socrata host this vocabulary was read from. | |
| notice | No | Guidance when the response is a subset of the vocabulary, when a filter too short to discriminate was ignored, when the filter matched nothing, or when tag_offset ran past the end of the matches. | |
| tagCount | No | Tags matching the filter, before tag_limit and tag_offset. | |
| truncated | No | True when the returned tags are a subset of the matching ones. Absent means every matching tag is in this response. | |
| categories | No | Every domain category matching the filter, ranked by entry count. Pass a value to cdc_discover_datasets' category input exactly as spelled here. | |
| nextOffset | No | Value to pass as tag_offset on the next call to continue after the last tag returned. Present only while matching tags remain. | |
| categoryCount | No | Categories matching the filter. Every one of them is in this response. | |
| vocabularySize | No | Size of each full vocabulary on this host, before any filter was applied. | |
| truncationCeiling | No | Upper bound on the entry count of every tag not returned. Tags are ranked by entry count, so no omitted tag is carried by more entries than the last one shown. |