Reusable definitions exposed by the product OpenAPI contract.
Pagination
{
"type": "object",
"required": [
"total",
"limit",
"offset",
"nextOffset",
"order",
"from",
"to"
],
"properties": {
"total": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"nextOffset": {
"type": "integer",
"nullable": true
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"from": {
"type": "string",
"format": "date",
"nullable": true
},
"to": {
"type": "string",
"format": "date",
"nullable": true
}
}
}Series
{
"type": "object",
"required": [
"slug",
"title",
"description",
"category",
"unit",
"unitLabel",
"frequency",
"dateGranularity",
"history",
"latestObservation",
"source",
"freshness",
"revisions",
"derivation"
],
"properties": {
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitLabel": {
"type": "string"
},
"frequency": {
"type": "string"
},
"dateGranularity": {
"type": "string",
"enum": [
"day",
"month",
"quarter"
]
},
"history": {
"type": "object",
"required": [
"firstObservationDate",
"lastObservationDate",
"observationCount"
],
"properties": {
"firstObservationDate": {
"type": "string",
"format": "date"
},
"lastObservationDate": {
"type": "string",
"format": "date"
},
"observationCount": {
"type": "integer"
}
}
},
"latestObservation": {
"type": "object",
"required": [
"date",
"value"
],
"properties": {
"date": {
"type": "string",
"format": "date"
},
"value": {
"type": "number"
}
}
},
"source": {
"type": "object",
"required": [
"name",
"dataset",
"url",
"methodologyUrl",
"accessDate"
],
"properties": {
"name": {
"type": "string"
},
"dataset": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"methodologyUrl": {
"type": "string",
"format": "uri"
},
"accessDate": {
"type": "string",
"format": "date",
"nullable": true
},
"disclaimer": {
"type": "string",
"description": "Any source-required attribution or downstream-use disclaimer."
}
}
},
"freshness": {
"type": "object",
"required": [
"state",
"asOfDate"
],
"properties": {
"state": {
"type": "string",
"enum": [
"fresh",
"stale",
"retired"
]
},
"asOfDate": {
"type": "string",
"format": "date"
}
}
},
"revisions": {
"type": "object",
"description": "Source-vintage and revision semantics",
"additionalProperties": true
},
"derivation": {
"type": "object",
"nullable": true,
"description": "Formula and inputs for derived series",
"additionalProperties": true
}
}
}