ResponseMeta

Metadata envelope present in every response.

source object

Data provenance; null for catalog endpoints

anyOf

• SourceMeta
• null

datasetDataset (string)required

Dataset key, e.g. 'acs5'

vintage_yearVintage Year (integer)required

Survey vintage year, e.g. 2022

reference_period object

Human-readable reference period, e.g. '2018–2022'

anyOf

• string
• null

string

census_programCensus Program (string)

Default value: U.S. Census Bureau

variable_count object

Number of variables returned (data endpoint only)

anyOf

• integer
• null

integer

geography_count object

Number of geographies returned (data endpoint only)

anyOf

• integer
• null

integer

total_count object

Total records available before pagination (list endpoints)

anyOf

• integer
• null

integer

hint object

Contextual guidance when results are empty or limited

anyOf

• string
• null

string

request_idRequest Id (string)required

UUID identifying this request

elapsed_msElapsed Ms (integer)required

Server-side processing time in milliseconds

ResponseMeta

{
  "source": {
    "dataset": "string",
    "vintage_year": 0,
    "reference_period": "string",
    "census_program": "U.S. Census Bureau"
  },
  "variable_count": 0,
  "geography_count": 0,
  "total_count": 0,
  "hint": "string",
  "request_id": "string",
  "elapsed_ms": 0
}