spectrum-analytics_query-response-single

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-spectrum-analytics-query-response-single-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/spectrum-analytics_query-response-single",
  "title": "spectrum-analytics_query-response-single",
  "allOf": [
    {
      "$ref": "#/components/schemas/spectrum-analytics_api-response-single"
    },
    {
      "properties": {
        "result": {
          "properties": {
            "data": {
              "description": "List of columns returned by the analytics query.",
              "items": {
                "$ref": "#/components/schemas/spectrum-analytics_column"
              },
              "type": "array"
            },
            "data_lag": {
              "description": "Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.",
              "example": 3,
              "minimum": 0,
              "type": "number"
            },
            "max": {
              "allOf": [
                {
                  "description": "Maximum result for each selected metrics across all data."
                },
                {
                  "$ref": "#/components/schemas/spectrum-analytics_stat"
                }
              ]
            },
            "min": {
              "allOf": [
                {
                  "description": "Minimum result for each selected metrics across all data."
                },
                {
                  "$ref": "#/components/schemas/spectrum-analytics_stat"
                }
              ]
            },
            "query": {
              "$ref": "#/components/schemas/spectrum-analytics_query"
            },
            "rows": {
              "description": "Total number of rows in the result.",
              "example": 5,
              "minimum": 0,
              "type": "number"
            },
            "time_intervals": {
              "description": "List of time interval buckets: [start, end]",
              "items": {
                "items": {
                  "$ref": "#/components/schemas/spectrum-analytics_timestamp"
                },
                "type": "array"
              },
              "type": "array"
            },
            "totals": {
              "allOf": [
                {
                  "description": "Total result for each selected metrics across all data."
                },
                {
                  "$ref": "#/components/schemas/spectrum-analytics_stat"
                }
              ]
            }
          },
          "required": [
            "rows",
            "data",
            "data_lag",
            "min",
            "max",
            "totals",
            "query"
          ],
          "type": "object"
        }
      }
    }
  ]
}