Skip to main content
Version: Next

ExploreContextSchema

dataset object
cache_timeoutinteger

Duration (in seconds) of the caching timeout for this dataset.

column_formatsobject

Column formats.

columnsobject[]

Columns metadata.

databaseobject

Database associated with the dataset.

datasource_namestring

Dataset name.

default_endpointstring

Default endpoint for the dataset.

descriptionstring

Dataset description.

edit_urlstring

The URL for editing the dataset.

extraobject

JSON string containing extra configuration elements.

fetch_values_predicatestring

Predicate used when fetching values from the dataset.

filter_selectboolean

SELECT filter applied to the dataset.

filter_select_enabledboolean

If the SELECT filter is enabled.

granularity_sqlaarray[]

Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use granularity instead.

health_check_messagestring

Health check message.

idinteger

Dataset ID.

is_sqllab_viewboolean

If the dataset is a SQL Lab view.

main_dttm_colstring

The main temporal column.

metricsobject[]

Dataset metrics.

namestring

Dataset name.

offsetinteger

Dataset offset.

order_by_choicesarray[]

List of order by columns.

ownersinteger[]

List of owners identifiers

paramsobject

Extra params for the dataset.

permstring

Permission expression.

schemastring

Dataset schema.

select_starstring

Select all clause.

sqlstring

A SQL statement that defines the dataset.

table_namestring

The name of the table associated with the dataset.

template_paramsobject

Table template params.

time_grain_sqlaarray[]

List of temporal granularities supported by the dataset.

typestring

Dataset type.

uidstring

Dataset unique identifier.

verbose_mapobject

Mapping from raw name to verbose name.

form_dataobject

Form data from the Explore controls used to form the chart's data query.

messagestring

Any message related to the processed request.

slice object
cache_timeoutinteger

Duration (in seconds) of the caching timeout for this chart.

certification_detailsstring

Details of the certification.

certified_bystring

Person or group that has certified this dashboard.

changed_onstring<date-time>

Timestamp of the last modification.

changed_on_humanizedstring

Timestamp of the last modification in human readable form.

datasourcestring

Datasource identifier.

descriptionstring

Slice description.

description_markeddownstring

Sanitized HTML version of the chart description.

edit_urlstring

The URL for editing the slice.

form_dataobject

Form data associated with the slice.

is_managed_externallyboolean

If the chart is managed outside externally.

modifiedstring

Last modification in human readable form.

ownersinteger[]

Owners identifiers.

query_contextobject

The context associated with the query.

slice_idinteger

The slice ID.

slice_namestring

The slice name.

slice_urlstring

The slice URL.

ExploreContextSchema
{
"dataset": {
"cache_timeout": 0,
"column_formats": {},
"columns": [
{}
],
"database": {},
"datasource_name": "string",
"default_endpoint": "string",
"description": "string",
"edit_url": "string",
"extra": {},
"fetch_values_predicate": "string",
"filter_select": true,
"filter_select_enabled": true,
"granularity_sqla": [
{}
],
"health_check_message": "string",
"id": 0,
"is_sqllab_view": true,
"main_dttm_col": "string",
"metrics": [
{}
],
"name": "string",
"offset": 0,
"order_by_choices": [
"string"
],
"owners": [
0
],
"params": {},
"perm": "string",
"schema": "string",
"select_star": "string",
"sql": "string",
"table_name": "string",
"template_params": {},
"time_grain_sqla": [
"string"
],
"type": "string",
"uid": "string",
"verbose_map": {}
},
"form_data": {},
"message": "string",
"slice": {
"cache_timeout": 0,
"certification_details": "string",
"certified_by": "string",
"changed_on": "2024-07-29T15:51:28.071Z",
"changed_on_humanized": "string",
"datasource": "string",
"description": "string",
"description_markeddown": "string",
"edit_url": "string",
"form_data": {},
"is_managed_externally": true,
"modified": "string",
"owners": [
0
],
"query_context": {},
"slice_id": 0,
"slice_name": "string",
"slice_url": "string"
}
}