api.creativeforesight.io

{
  "additionalProperties": false,
  "properties": {
    "data": {
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/Observation"
          },
          {
            "additionalProperties": false,
            "properties": {
              "period_end": {
                "format": "date",
                "type": "string"
              },
              "period_start": {
                "format": "date",
                "type": "string"
              },
              "period_type": {
                "enum": [
                  "monthly",
                  "quarterly",
                  "annual"
                ],
                "type": "string"
              },
              "value": {
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "required": [
              "period_start",
              "period_end",
              "period_type",
              "value"
            ],
            "type": "object"
          }
        ]
      },
      "type": "array"
    },
    "meta": {
      "additionalProperties": false,
      "properties": {
        "concept": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "resolved_indicator": {
              "type": "string"
            },
            "source": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "resolved_indicator",
            "source"
          ],
          "type": "object"
        },
        "frequency": {
          "enum": [
            "monthly",
            "quarterly",
            "annual"
          ],
          "type": "string"
        },
        "indicator": {
          "type": "string"
        },
        "limit": {
          "maximum": 1000,
          "minimum": 0,
          "type": "integer"
        },
        "offset": {
          "minimum": 0,
          "type": "integer"
        },
        "region": {
          "type": [
            "string",
            "null"
          ]
        },
        "resample": {
          "additionalProperties": false,
          "properties": {
            "dropped_incomplete_trailing": {
              "type": "boolean"
            },
            "dropped_page_boundary_buckets": {
              "minimum": 0,
              "type": "integer"
            },
            "from": {
              "enum": [
                "daily",
                "weekly",
                "monthly",
                "quarterly",
                "annual"
              ],
              "type": "string"
            },
            "method": {
              "enum": [
                "mean",
                "last",
                "sum"
              ],
              "type": "string"
            },
            "to": {
              "enum": [
                "monthly",
                "quarterly",
                "annual"
              ],
              "type": "string"
            }
          },
          "required": [
            "method",
            "from",
            "to"
          ],
          "type": "object"
        },
        "retired": {
          "additionalProperties": false,
          "description": "Present when the series has been retired from the catalog (orphaned, superseded, discontinued upstream or never ingested). Its stored data is still served; it no longer updates.",
          "properties": {
            "reason": {
              "type": "string"
            },
            "replaced_by": {
              "description": "The indicator code that replaces this series, when there is one.",
              "type": "string"
            },
            "retired_at": {
              "format": "date",
              "type": "string"
            }
          },
          "required": [
            "retired_at",
            "reason"
          ],
          "type": "object"
        },
        "source_attribution": {
          "type": "string"
        },
        "total": {
          "minimum": 0,
          "type": "integer"
        },
        "transform": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "enum": [
                    "yoy",
                    "mom",
                    "qoq",
                    "log"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "kind"
              ],
              "type": "object"
            },
            {
              "additionalProperties": false,
              "properties": {
                "base": {
                  "format": "date",
                  "type": "string"
                },
                "kind": {
                  "const": "index",
                  "type": "string"
                }
              },
              "required": [
                "kind",
                "base"
              ],
              "type": "object"
            }
          ]
        },
        "unit": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "indicator",
        "region",
        "unit",
        "total",
        "limit",
        "offset"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}