Version 4.0.24.14 (latest)
Get information about a lookml model explore.
Request
GET
/lookml_models/{lookml_model_name}/explores/{explore_name}
Datatype
Description
Request
path
Expand HTTP Path definition...
lookml_model_name
Name of lookml model.
explore_name
Name of explore.
query
Expand HTTP Query definition...
fields
Requested fields.
add_drills_metadata
Whether response should include drill field metadata.
Response
200: LookML Model Explore
Datatype
Description
(object)
id
lock
Fully qualified explore name (model name plus explore name)
name
lock
Explore name
description
lock
Description
label
lock
Label
title
lock
Explore title
scopes
can_total
lock
Can Total
can_develop
lock
Can Develop LookML
can_see_lookml
lock
Can See LookML
lookml_link
lock
A URL linking to the definition of this explore in the LookML IDE.
can_save
lock
Can Save
can_explain
lock
Can Explain
can_pivot_in_db
lock
Can pivot in the DB
can_subtotal
lock
Can use subtotals
has_timezone_support
lock
Has timezone support
supports_cost_estimate
lock
Cost estimates supported
connection_name
lock
Connection name
null_sort_treatment
lock
How nulls are sorted, possible values are "low", "high", "first" and "last"
files
source_file
lock
Primary source_file file
project_name
lock
Name of project
model_name
lock
Name of model
view_name
lock
Name of view
hidden
lock
Is hidden
sql_table_name
lock
A sql_table_name expression that defines what sql table the view/explore maps onto. Example: "prod_orders2 AS orders" in a view named orders.
access_filter_fields
access_filters
Expand LookmlModelExploreAccessFilter definition...
field
lock
Field to be filtered
user_attribute
lock
User attribute name
aliases
Expand LookmlModelExploreAlias definition...
name
lock
Name
value
lock
Value
always_filter
Expand LookmlModelExploreAlwaysFilter definition...
name
lock
Name
value
lock
Value
conditionally_filter
Expand LookmlModelExploreConditionallyFilter definition...
name
lock
Name
value
lock
Value
index_fields
sets
Expand LookmlModelExploreSet definition...
name
lock
Name
value
tags
errors
Expand LookmlModelExploreError definition...
message
lock
Error Message
details
lock
Details
error_pos
lock
Error source location
field_error
lock
Is this a field error
fields
lock
Fields
Expand LookmlModelExploreFieldset definition...
dimensions
Expand LookmlModelExploreField definition...
align
lock
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
lock
Whether it's possible to filter on this field.
category
lock
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
lock
The default value that this field uses when filtering. Null if there is no default value.
description
lock
Description
dimension_group
lock
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
enumerations
error
lock
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
lock
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
lock
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
lock
The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".
fiscal_month_offset
lock
An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.
has_allowed_values
lock
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
lock
Whether this field has links or drill fields defined.
hidden
lock
Whether this field should be hidden from the user interface.
is_filter
lock
Whether this field is a filter.
is_fiscal
lock
Whether this field represents a fiscal time value.
is_numeric
lock
Whether this field is of a type that represents a numeric value.
is_timeframe
lock
Whether this field is of a type that represents a time value.
can_time_filter
lock
Whether this field can be time filtered.
time_interval
lock
Details on the time interval this field represents, if it is_timeframe.
label
lock
Fully-qualified human-readable label of the field.
label_from_parameter
lock
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
lock
The human-readable label of the field, without the view label.
lookml_link
lock
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
lock
If applicable, a map layer this field is associated with.
measure
lock
Whether this field is a measure.
name
lock
Fully-qualified name of the field.
strict_value_format
lock
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
lock
Whether this field is a parameter.
permanent
lock
Whether this field can be removed from a query.
primary_key
lock
Whether or not the field represents a primary key.
project_name
lock
The name of the project this field is defined in.
requires_refresh_on_sort
lock
When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.
scope
lock
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
lock
Whether this field can be sorted.
source_file
lock
The path portion of source_file_path.
source_file_path
lock
The fully-qualified path of the project file this field is defined in.
sql
lock
SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
sql_case
filters
suggest_dimension
lock
The name of the dimension to base suggest queries from.
suggest_explore
lock
The name of the explore to base suggest queries from.
suggestable
lock
Whether or not suggestions are possible for this field.
suggestions
tags
type
lock
The LookML type of the field.
user_attribute_filter_types
value_format
lock
If specified, the LookML value format string for formatting values of this field.
view
lock
The name of the view this field belongs to.
view_label
lock
The human-readable label of the view the field belongs to.
dynamic
lock
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
lock
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
lock
The number of times this field has been used in queries
original_view
lock
The name of the view this field is defined in. This will be different than "view" when the view has been joined via a different name using the "from" parameter.
measures
Expand LookmlModelExploreField definition...
align
lock
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
lock
Whether it's possible to filter on this field.
category
lock
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
lock
The default value that this field uses when filtering. Null if there is no default value.
description
lock
Description
dimension_group
lock
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
enumerations
error
lock
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
lock
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
lock
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
lock
The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".
fiscal_month_offset
lock
An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.
has_allowed_values
lock
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
lock
Whether this field has links or drill fields defined.
hidden
lock
Whether this field should be hidden from the user interface.
is_filter
lock
Whether this field is a filter.
is_fiscal
lock
Whether this field represents a fiscal time value.
is_numeric
lock
Whether this field is of a type that represents a numeric value.
is_timeframe
lock
Whether this field is of a type that represents a time value.
can_time_filter
lock
Whether this field can be time filtered.
time_interval
lock
Details on the time interval this field represents, if it is_timeframe.
label
lock
Fully-qualified human-readable label of the field.
label_from_parameter
lock
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
lock
The human-readable label of the field, without the view label.
lookml_link
lock
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
lock
If applicable, a map layer this field is associated with.
measure
lock
Whether this field is a measure.
name
lock
Fully-qualified name of the field.
strict_value_format
lock
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
lock
Whether this field is a parameter.
permanent
lock
Whether this field can be removed from a query.
primary_key
lock
Whether or not the field represents a primary key.
project_name
lock
The name of the project this field is defined in.
requires_refresh_on_sort
lock
When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.
scope
lock
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
lock
Whether this field can be sorted.
source_file
lock
The path portion of source_file_path.
source_file_path
lock
The fully-qualified path of the project file this field is defined in.
sql
lock
SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
sql_case
filters
suggest_dimension
lock
The name of the dimension to base suggest queries from.
suggest_explore
lock
The name of the explore to base suggest queries from.
suggestable
lock
Whether or not suggestions are possible for this field.
suggestions
tags
type
lock
The LookML type of the field.
user_attribute_filter_types
value_format
lock
If specified, the LookML value format string for formatting values of this field.
view
lock
The name of the view this field belongs to.
view_label
lock
The human-readable label of the view the field belongs to.
dynamic
lock
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
lock
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
lock
The number of times this field has been used in queries
original_view
lock
The name of the view this field is defined in. This will be different than "view" when the view has been joined via a different name using the "from" parameter.
filters
Expand LookmlModelExploreField definition...
align
lock
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
lock
Whether it's possible to filter on this field.
category
lock
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
lock
The default value that this field uses when filtering. Null if there is no default value.
description
lock
Description
dimension_group
lock
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
enumerations
error
lock
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
lock
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
lock
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
lock
The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".
fiscal_month_offset
lock
An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.
has_allowed_values
lock
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
lock
Whether this field has links or drill fields defined.
hidden
lock
Whether this field should be hidden from the user interface.
is_filter
lock
Whether this field is a filter.
is_fiscal
lock
Whether this field represents a fiscal time value.
is_numeric
lock
Whether this field is of a type that represents a numeric value.
is_timeframe
lock
Whether this field is of a type that represents a time value.
can_time_filter
lock
Whether this field can be time filtered.
time_interval
lock
Details on the time interval this field represents, if it is_timeframe.
label
lock
Fully-qualified human-readable label of the field.
label_from_parameter
lock
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
lock
The human-readable label of the field, without the view label.
lookml_link
lock
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
lock
If applicable, a map layer this field is associated with.
measure
lock
Whether this field is a measure.
name
lock
Fully-qualified name of the field.
strict_value_format
lock
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
lock
Whether this field is a parameter.
permanent
lock
Whether this field can be removed from a query.
primary_key
lock
Whether or not the field represents a primary key.
project_name
lock
The name of the project this field is defined in.
requires_refresh_on_sort
lock
When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.
scope
lock
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
lock
Whether this field can be sorted.
source_file
lock
The path portion of source_file_path.
source_file_path
lock
The fully-qualified path of the project file this field is defined in.
sql
lock
SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
sql_case
filters
suggest_dimension
lock
The name of the dimension to base suggest queries from.
suggest_explore
lock
The name of the explore to base suggest queries from.
suggestable
lock
Whether or not suggestions are possible for this field.
suggestions
tags
type
lock
The LookML type of the field.
user_attribute_filter_types
value_format
lock
If specified, the LookML value format string for formatting values of this field.
view
lock
The name of the view this field belongs to.
view_label
lock
The human-readable label of the view the field belongs to.
dynamic
lock
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
lock
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
lock
The number of times this field has been used in queries
original_view
lock
The name of the view this field is defined in. This will be different than "view" when the view has been joined via a different name using the "from" parameter.
parameters
Expand LookmlModelExploreField definition...
align
lock
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
lock
Whether it's possible to filter on this field.
category
lock
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
lock
The default value that this field uses when filtering. Null if there is no default value.
description
lock
Description
dimension_group
lock
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
enumerations
error
lock
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
lock
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
lock
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
lock
The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".
fiscal_month_offset
lock
An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.
has_allowed_values
lock
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
lock
Whether this field has links or drill fields defined.
hidden
lock
Whether this field should be hidden from the user interface.
is_filter
lock
Whether this field is a filter.
is_fiscal
lock
Whether this field represents a fiscal time value.
is_numeric
lock
Whether this field is of a type that represents a numeric value.
is_timeframe
lock
Whether this field is of a type that represents a time value.
can_time_filter
lock
Whether this field can be time filtered.
time_interval
lock
Details on the time interval this field represents, if it is_timeframe.
label
lock
Fully-qualified human-readable label of the field.
label_from_parameter
lock
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
lock
The human-readable label of the field, without the view label.
lookml_link
lock
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
lock
If applicable, a map layer this field is associated with.
measure
lock
Whether this field is a measure.
name
lock
Fully-qualified name of the field.
strict_value_format
lock
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
lock
Whether this field is a parameter.
permanent
lock
Whether this field can be removed from a query.
primary_key
lock
Whether or not the field represents a primary key.
project_name
lock
The name of the project this field is defined in.
requires_refresh_on_sort
lock
When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.
scope
lock
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
lock
Whether this field can be sorted.
source_file
lock
The path portion of source_file_path.
source_file_path
lock
The fully-qualified path of the project file this field is defined in.
sql
lock
SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
sql_case
filters
suggest_dimension
lock
The name of the dimension to base suggest queries from.
suggest_explore
lock
The name of the explore to base suggest queries from.
suggestable
lock
Whether or not suggestions are possible for this field.
suggestions
tags
type
lock
The LookML type of the field.
user_attribute_filter_types
value_format
lock
If specified, the LookML value format string for formatting values of this field.
view
lock
The name of the view this field belongs to.
view_label
lock
The human-readable label of the view the field belongs to.
dynamic
lock
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
lock
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
lock
The number of times this field has been used in queries
original_view
lock
The name of the view this field is defined in. This will be different than "view" when the view has been joined via a different name using the "from" parameter.
joins
Expand LookmlModelExploreJoins definition...
name
lock
Name of this join (and name of the view to join)
dependent_fields
fields
foreign_key
lock
Name of the dimension in this explore whose value is in the primary key of the joined view
from
lock
Name of view to join
outer_only
lock
Specifies whether all queries must use an outer join
relationship
lock
many_to_one, one_to_one, one_to_many, many_to_many
required_joins
sql_foreign_key
lock
SQL expression that produces a foreign key
sql_on
lock
SQL ON expression describing the join condition
sql_table_name
lock
SQL table name to join
type
lock
The join type: left_outer, full_outer, inner, or cross
view_label
lock
Label to display in UI selectors
group_label
lock
Label used to group explores in the navigation menus
supported_measure_types
Expand LookmlModelExploreSupportedMeasureType definition...
dimension_type
lock
measure_types
always_join
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/lookml_model_explore.py |