Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.RequestSchema.json
2026-07-28 21:39:01 +07:00

127 lines
3.9 KiB
JSON

{
"title": "Body",
"body": {
"content": {
"application/json": {
"examples": {
"numerical_range_filter": {
"summary": "Numerical Range Filter",
"value": {
"dataMask": {
"extraFormData": {
"filters": [
{ "col": "tz_offset", "op": ">=", "val": [1000] },
{ "col": "tz_offset", "op": "<=", "val": [2000] }
]
},
"filterState": {
"label": "1000 <= x <= 200",
"value": [1000, 2000]
},
"id": "NATIVE_FILTER_ID"
}
}
},
"time_grain_filter": {
"summary": "Time Grain Filter",
"value": {
"dataMask": {
"extraFormData": {
"time_grain_sqla": "P1W/1970-01-03T00:00:00Z"
},
"filterState": {
"label": "Week ending Saturday",
"value": ["P1W/1970-01-03T00:00:00Z"]
},
"id": "NATIVE_FILTER_ID"
}
}
},
"time_range_filter": {
"summary": "Time Range Filter",
"value": {
"dataMask": {
"extraFormData": {
"time_range": "DATEADD(DATETIME(\"2025-01-16T00:00:00\"), -7, day) : 2025-01-16T00:00:00"
},
"filterState": {
"value": "DATEADD(DATETIME(\"2025-01-16T00:00:00\"), -7, day) : 2025-01-16T00:00:00"
},
"id": "NATIVE_FILTER_ID"
}
}
},
"timecolumn_filter": {
"summary": "Time Column Filter",
"value": {
"dataMask": {
"extraFormData": { "granularity_sqla": "order_date" },
"filterState": { "value": ["order_date"] },
"id": "NATIVE_FILTER_ID"
}
}
},
"value_filter": {
"summary": "Value Filter",
"value": {
"dataMask": {
"extraFormData": {
"filters": [
{ "col": "real_name", "op": "IN", "val": ["John Doe"] }
]
},
"filterState": { "value": ["John Doe"] },
"id": "NATIVE_FILTER_ID"
}
}
}
},
"schema": {
"properties": {
"activeTabs": {
"description": "Current active dashboard tabs",
"items": { "type": "string" },
"nullable": true,
"type": "array"
},
"anchor": {
"description": "Optional anchor link added to url hash",
"nullable": true,
"type": "string"
},
"chartStates": {
"description": "Chart-level state for stateful tables (column order, sorting, filtering)",
"nullable": true,
"type": "object"
},
"dataMask": {
"description": "Data mask used for native filter state",
"nullable": true,
"type": "object"
},
"urlParams": {
"description": "URL Parameters",
"items": {
"description": "URL Parameter key-value pair",
"nullable": true
},
"nullable": true,
"type": "array"
}
},
"type": "object",
"title": "DashboardPermalinkStateSchema"
},
"example": {
"activeTabs": ["string"],
"anchor": "string",
"chartStates": {},
"dataMask": {},
"urlParams": [{}]
}
}
},
"required": true
}
}