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

72 lines
2.3 KiB
JSON

{
"schema": {
"properties": {
"column_order": {
"description": "Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)",
"items": { "type": "string" },
"nullable": true,
"type": "array"
},
"having": {
"description": "HAVING clause to be added to aggregate queries using AND operator.",
"type": "string"
},
"instant_time_comparison_range": {
"description": "This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.",
"nullable": true,
"type": "string"
},
"relative_end": {
"description": "End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`",
"enum": ["today", "now"],
"type": "string"
},
"relative_start": {
"description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`",
"enum": ["today", "now"],
"type": "string"
},
"time_grain_sqla": {
"description": "To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.",
"enum": [
"PT1S",
"PT5S",
"PT30S",
"PT1M",
"PT5M",
"PT10M",
"PT15M",
"PT30M",
"PT1H",
"PT6H",
"P1D",
"P1W",
"P1M",
"P3M",
"P1Y",
"1969-12-28T00:00:00Z/P1W",
"1969-12-29T00:00:00Z/P1W",
"P1W/1970-01-03T00:00:00Z",
"P1W/1970-01-04T00:00:00Z",
null
],
"example": "P1D",
"nullable": true,
"type": "string"
},
"transpile_to_dialect": {
"description": "If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.",
"nullable": true,
"type": "boolean"
},
"where": {
"description": "WHERE clause to be added to queries using AND operator.",
"type": "string"
}
},
"type": "object",
"title": "ChartDataExtras"
},
"schemaType": "response"
}