{"ok":true,"site":"data-cdc","host":"data.cdc.gov","about":"data.cdc.gov is the CDC's open-data portal (Socrata). This CLI searches the dataset catalog, lists categories and tags, reads dataset metadata, and queries or exports dataset rows through the public Socrata Discovery, SODA and views APIs.","commands":[{"command":"search-datasets","summary":"Search the data.cdc.gov catalog by keyword, with optional category/tag/type filters, sort order and paging","params":[{"name":"q","type":"string","description":"Full-text search keywords"},{"name":"categories","type":"string","description":"Filter by domain category name. Get the names from list-categories, e.g. 'Vaccinations' or 'National Center for Health Statistics'."},{"name":"tags","type":"string","description":"Filter by domain tag. Get the tags from list-tags, e.g. 'flu' or 'covid-19'."},{"name":"only","type":"string","description":"Restrict results to one asset type","oneOf":["dataset","chart","map","filter","file","story","link","href","datalens","calendar","form"]},{"name":"order","type":"string","description":"Sort order. Relevance is used when omitted.","oneOf":["relevance","name","createdAt","updatedAt","page_views_last_week","page_views_last_month","page_views_total"]},{"name":"api_limit","type":"number","description":"Results per page (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":20},{"name":"offset","type":"number","description":"Number of results to skip, for paging","default":0}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/search-datasets?q=influenza&categories=Vaccinations&tags=flu&only=dataset&order=updatedAt"},{"command":"list-categories","summary":"List all dataset categories on data.cdc.gov with their dataset counts","params":[],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/list-categories"},{"command":"list-tags","summary":"List the most-used dataset tags on data.cdc.gov with their counts","params":[],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/list-tags"},{"command":"autocomplete-datasets","summary":"Suggest dataset titles that match a partial search term","params":[{"name":"q","type":"string","required":true,"description":"Partial title text"}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/autocomplete-datasets?q=influ"},{"command":"get-dataset","summary":"Get full metadata for one dataset by its 4x4 id, including columns, field names, data types and stats","params":[{"name":"id","type":"string","required":true,"description":"Dataset 4x4 id, e.g. ynw2-4viq"}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/get-dataset"},{"command":"get-dataset-metadata","summary":"Get a dataset's catalog metadata: tags, contact info, custom fields, ISO update dates and API/web URIs","params":[{"name":"id","type":"string","required":true,"description":"Dataset 4x4 id, e.g. vh55-3he6"}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/get-dataset-metadata"},{"command":"query-rows","summary":"Query a dataset's rows with SoQL (SODA API): filter, full-text search, select/aggregate, group, sort and page","params":[{"name":"id","type":"string","required":true,"description":"Dataset 4x4 id, e.g. ynw2-4viq (find ids with search-datasets)"},{"name":"where","type":"string","description":"SoQL filter expression on column field names (see get-dataset columns.fieldName), e.g. jurisdiction='United States'"},{"name":"q","type":"string","description":"Full-text search across all row values"},{"name":"select","type":"string","description":"Comma-separated columns or aggregates, e.g. geography,count(*)"},{"name":"group","type":"string","description":"Columns to group by. Use together with an aggregate in select."},{"name":"order","type":"string","description":"Sort expression, e.g. 'week_ending_date DESC'"},{"name":"api_limit","type":"number","description":"Maximum number of rows to return (sent to the site as \"$limit\"; clify's own --limit only shapes the output)","default":100},{"name":"offset","type":"number","description":"Number of rows to skip, for paging (sent as \"$offset\")","default":0}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/query-rows?where=jurisdiction%3D%27United+States%27&q=Texas&select=geography%2Ccount%28*%29&group=geography&order=week_ending_date+DESC&api_limit=5"},{"command":"run-soql-query","summary":"Run a full SoQL query string against a dataset through the v3 query API, e.g. 'select jurisdiction, sum(influenza_deaths) group by jurisdiction limit 10'","params":[{"name":"id","type":"string","required":true,"description":"Dataset 4x4 id"},{"name":"query","type":"string","required":true,"description":"SoQL query string (SELECT ... WHERE ... GROUP BY ... ORDER BY ... LIMIT ...), without a FROM clause"}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/run-soql-query?query=select+jurisdiction%2C+sum%28influenza_deaths%29+group+by+jurisdiction+limit+10"},{"command":"export-rows","summary":"Download a dataset export in JSON: view metadata under meta, rows as positional arrays under data","params":[{"name":"id","type":"string","required":true,"description":"Dataset 4x4 id"},{"name":"max_rows","type":"number","description":"Maximum number of rows to export. Omit for the full dataset, which can be very large."}],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/export-rows?max_rows=5"},{"command":"get-data-catalog","summary":"Get the full DCAT (Project Open Data) catalog of every public dataset on data.cdc.gov","params":[],"exampleUrl":"https://clify-dev.netlify.app/data-cdc/get-data-catalog"}]}