U.S. Bureau of Labor Statistics · Schema

SurveyMetadataResponse

Response containing metadata for a specific survey.

Federal GovernmentLaborStatisticsEmploymentEconomic Data

Properties

Name Type Description
status string Request status.
responseTime integer Response time in milliseconds.
message array
Results object Results containing survey metadata.
View JSON Schema on GitHub

JSON Schema

bls-survey-metadata-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/u-s-bureau-of-labor-statistics/refs/heads/main/json-schema/bls-survey-metadata-response-schema.json",
  "title": "SurveyMetadataResponse",
  "description": "Response containing metadata for a specific survey.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Request status.",
      "example": "REQUEST_SUCCEEDED"
    },
    "responseTime": {
      "type": "integer",
      "description": "Response time in milliseconds.",
      "example": 112
    },
    "message": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "Results": {
      "type": "object",
      "description": "Results containing survey metadata.",
      "properties": {
        "survey": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Survey"
          }
        }
      }
    }
  }
}