mirror of
https://github.com/apache/superset.git
synced 2026-08-04 13:02:41 +00:00
67 lines
2.3 KiB
JSON
67 lines
2.3 KiB
JSON
{
|
|
"schema": {
|
|
"properties": {
|
|
"aggregate": {
|
|
"description": "Aggregation operator.Only required for simple expression types.",
|
|
"enum": ["AVG", "COUNT", "COUNT_DISTINCT", "MAX", "MIN", "SUM"],
|
|
"type": "string"
|
|
},
|
|
"column": {
|
|
"properties": {
|
|
"column_name": {
|
|
"description": "The name of the target column",
|
|
"example": "mycol",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of target column",
|
|
"example": "BIGINT",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ChartDataColumn"
|
|
},
|
|
"expressionType": {
|
|
"description": "Simple or SQL metric",
|
|
"enum": ["SIMPLE", "SQL"],
|
|
"example": "SQL",
|
|
"type": "string"
|
|
},
|
|
"hasCustomLabel": {
|
|
"description": "When false, the label will be automatically generated based on the aggregate expression. When true, a custom label has to be specified.",
|
|
"example": true,
|
|
"type": "boolean"
|
|
},
|
|
"isExtra": {
|
|
"description": "Indicates if the filter has been added by a filter component as opposed to being a part of the original query.",
|
|
"type": "boolean"
|
|
},
|
|
"label": {
|
|
"description": "Label for the metric. Is automatically generated unlesshasCustomLabel is true, in which case label must be defined.",
|
|
"example": "Weighted observations",
|
|
"type": "string"
|
|
},
|
|
"optionName": {
|
|
"description": "Unique identifier. Can be any string value, as long as all metrics have a unique identifier. If undefined, a random namewill be generated.",
|
|
"example": "metric_aec60732-fac0-4b17-b736-93f1a5c93e30",
|
|
"type": "string"
|
|
},
|
|
"sqlExpression": {
|
|
"description": "The metric as defined by a SQL aggregate expression. Only required for SQL expression type.",
|
|
"example": "SUM(weight * observations) / SUM(weight)",
|
|
"type": "string"
|
|
},
|
|
"timeGrain": {
|
|
"description": "Optional time grain for temporal filters",
|
|
"example": "PT1M",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["expressionType"],
|
|
"type": "object",
|
|
"title": "ChartDataAdhocMetricSchema"
|
|
},
|
|
"schemaType": "response"
|
|
}
|