Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.Schema.json

116 lines
3.3 KiB
JSON

{
"schema": {
"properties": {
"annotation_data": {
"description": "All requested annotation data",
"items": {
"additionalProperties": { "type": "string" },
"type": "object"
},
"nullable": true,
"type": "array"
},
"applied_filters": {
"description": "A list with applied filters",
"items": { "type": "object" },
"type": "array"
},
"cache_key": {
"description": "Unique cache key for query object",
"nullable": true,
"type": "string"
},
"cache_timeout": {
"description": "Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.",
"nullable": true,
"type": "integer"
},
"cached_dttm": {
"description": "Cache timestamp",
"nullable": true,
"type": "string"
},
"colnames": {
"description": "A list of column names",
"items": { "type": "string" },
"type": "array"
},
"coltypes": {
"description": "A list of generic data types of each column",
"items": { "type": "integer" },
"type": "array"
},
"data": {
"description": "A list with results",
"items": { "type": "object" },
"type": "array"
},
"detected_currency": {
"default": null,
"description": "Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.",
"nullable": true,
"type": "string"
},
"error": { "description": "Error", "nullable": true, "type": "string" },
"from_dttm": {
"description": "Start timestamp of time range",
"nullable": true,
"type": "integer"
},
"is_cached": { "description": "Is the result cached", "type": "boolean" },
"queried_dttm": {
"description": "UTC timestamp when the query was executed (ISO 8601 format)",
"nullable": true,
"type": "string"
},
"query": {
"description": "The executed query statement. May be absent when validation errors occur.",
"nullable": true,
"type": "string"
},
"rejected_filters": {
"description": "A list with rejected filters",
"items": { "type": "object" },
"type": "array"
},
"rowcount": {
"description": "Amount of rows in result set",
"type": "integer"
},
"stacktrace": {
"description": "Stacktrace if there was an error",
"nullable": true,
"type": "string"
},
"status": {
"description": "Status of the query",
"enum": [
"stopped",
"failed",
"pending",
"running",
"scheduled",
"success",
"timed_out"
],
"type": "string"
},
"to_dttm": {
"description": "End timestamp of time range",
"nullable": true,
"type": "integer"
}
},
"required": [
"cache_key",
"cache_timeout",
"cached_dttm",
"is_cached",
"queried_dttm"
],
"type": "object",
"title": "ChartDataResponseResult"
},
"schemaType": "response"
}