LookmlModelExplore

Version 4.0.24.20 (latest)
Datatype
Description
(object)
object
id
string
Fully qualified explore name (model name plus explore name)
name
string
Explore name
description
string
Description
label
string
Label
title
string
Explore title
scopes
string[]
can_total
boolean
Can Total
can_develop
boolean
Can Develop LookML
can_see_lookml
boolean
Can See LookML
lookml_link
string
A URL linking to the definition of this explore in the LookML IDE.
can_save
boolean
Can Save
can_explain
boolean
Can Explain
can_pivot_in_db
boolean
Can pivot in the DB
can_subtotal
boolean
Can use subtotals
has_timezone_support
boolean
Has timezone support
supports_cost_estimate
boolean
Cost estimates supported
connection_name
string
Connection name
null_sort_treatment
string
How nulls are sorted, possible values are "low", "high", "first" and "last"
files
string[]
source_file
string
Primary source_file file
project_name
string
Name of project
model_name
string
Name of model
view_name
string
Name of view
hidden
boolean
Is hidden
sql_table_name
string
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
string[]
Expand LookmlModelExploreAccessFilter definition...
field
string
Field to be filtered
user_attribute
string
User attribute name
Expand LookmlModelExploreAlias definition...
name
string
Name
value
string
Value
Expand LookmlModelExploreAlwaysFilter definition...
name
string
Name
value
string
Value
conditionally_filter
Expand LookmlModelExploreConditionallyFilter definition...
name
string
Name
value
string
Value
index_fields
string[]
Expand LookmlModelExploreSet definition...
name
string
Name
value
string[]
tags
string[]
Expand LookmlModelExploreError definition...
message
string
Error Message
details
any
Details
error_pos
string
Error source location
field_error
boolean
Is this a field error
fields
Fields
Expand LookmlModelExploreFieldset definition...
Expand LookmlModelExploreField definition...
align
string
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
boolean
Whether it's possible to filter on this field.
category
string
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
string
The default value that this field uses when filtering. Null if there is no default value.
description
string
Description
dimension_group
string
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
string[]
error
string
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
string
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
string
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
string
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
integer
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
boolean
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
boolean
Whether this field has links or drill fields defined.
hidden
boolean
Whether this field should be hidden from the user interface.
is_filter
boolean
Whether this field is a filter.
is_fiscal
boolean
Whether this field represents a fiscal time value.
is_numeric
boolean
Whether this field is of a type that represents a numeric value.
is_timeframe
boolean
Whether this field is of a type that represents a time value.
can_time_filter
boolean
Whether this field can be time filtered.
time_interval
Details on the time interval this field represents, if it is_timeframe.
label
string
Fully-qualified human-readable label of the field.
label_from_parameter
string
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
string
The human-readable label of the field, without the view label.
lookml_link
string
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
If applicable, a map layer this field is associated with.
measure
boolean
Whether this field is a measure.
name
string
Fully-qualified name of the field.
strict_value_format
boolean
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
boolean
Whether this field is a parameter.
permanent
boolean
Whether this field can be removed from a query.
primary_key
boolean
Whether or not the field represents a primary key.
project_name
string
The name of the project this field is defined in.
requires_refresh_on_sort
boolean
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
string
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
boolean
Whether this field can be sorted.
source_file
string
The path portion of source_file_path.
source_file_path
string
The fully-qualified path of the project file this field is defined in.
sql
string
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.
suggest_dimension
string
The name of the dimension to base suggest queries from.
suggest_explore
string
The name of the explore to base suggest queries from.
suggestable
boolean
Whether or not suggestions are possible for this field.
suggestions
string[]
tags
string[]
type
string
The LookML type of the field.
user_attribute_filter_types
string[]
value_format
string
If specified, the LookML value format string for formatting values of this field.
view
string
The name of the view this field belongs to.
view_label
string
The human-readable label of the view the field belongs to.
dynamic
boolean
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
string
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
integer
The number of times this field has been used in queries
original_view
string
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.
Expand LookmlModelExploreField definition...
align
string
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
boolean
Whether it's possible to filter on this field.
category
string
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
string
The default value that this field uses when filtering. Null if there is no default value.
description
string
Description
dimension_group
string
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
string[]
error
string
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
string
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
string
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
string
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
integer
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
boolean
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
boolean
Whether this field has links or drill fields defined.
hidden
boolean
Whether this field should be hidden from the user interface.
is_filter
boolean
Whether this field is a filter.
is_fiscal
boolean
Whether this field represents a fiscal time value.
is_numeric
boolean
Whether this field is of a type that represents a numeric value.
is_timeframe
boolean
Whether this field is of a type that represents a time value.
can_time_filter
boolean
Whether this field can be time filtered.
time_interval
Details on the time interval this field represents, if it is_timeframe.
label
string
Fully-qualified human-readable label of the field.
label_from_parameter
string
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
string
The human-readable label of the field, without the view label.
lookml_link
string
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
If applicable, a map layer this field is associated with.
measure
boolean
Whether this field is a measure.
name
string
Fully-qualified name of the field.
strict_value_format
boolean
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
boolean
Whether this field is a parameter.
permanent
boolean
Whether this field can be removed from a query.
primary_key
boolean
Whether or not the field represents a primary key.
project_name
string
The name of the project this field is defined in.
requires_refresh_on_sort
boolean
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
string
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
boolean
Whether this field can be sorted.
source_file
string
The path portion of source_file_path.
source_file_path
string
The fully-qualified path of the project file this field is defined in.
sql
string
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.
suggest_dimension
string
The name of the dimension to base suggest queries from.
suggest_explore
string
The name of the explore to base suggest queries from.
suggestable
boolean
Whether or not suggestions are possible for this field.
suggestions
string[]
tags
string[]
type
string
The LookML type of the field.
user_attribute_filter_types
string[]
value_format
string
If specified, the LookML value format string for formatting values of this field.
view
string
The name of the view this field belongs to.
view_label
string
The human-readable label of the view the field belongs to.
dynamic
boolean
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
string
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
integer
The number of times this field has been used in queries
original_view
string
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.
Expand LookmlModelExploreField definition...
align
string
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
boolean
Whether it's possible to filter on this field.
category
string
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
string
The default value that this field uses when filtering. Null if there is no default value.
description
string
Description
dimension_group
string
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
string[]
error
string
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
string
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
string
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
string
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
integer
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
boolean
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
boolean
Whether this field has links or drill fields defined.
hidden
boolean
Whether this field should be hidden from the user interface.
is_filter
boolean
Whether this field is a filter.
is_fiscal
boolean
Whether this field represents a fiscal time value.
is_numeric
boolean
Whether this field is of a type that represents a numeric value.
is_timeframe
boolean
Whether this field is of a type that represents a time value.
can_time_filter
boolean
Whether this field can be time filtered.
time_interval
Details on the time interval this field represents, if it is_timeframe.
label
string
Fully-qualified human-readable label of the field.
label_from_parameter
string
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
string
The human-readable label of the field, without the view label.
lookml_link
string
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
If applicable, a map layer this field is associated with.
measure
boolean
Whether this field is a measure.
name
string
Fully-qualified name of the field.
strict_value_format
boolean
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
boolean
Whether this field is a parameter.
permanent
boolean
Whether this field can be removed from a query.
primary_key
boolean
Whether or not the field represents a primary key.
project_name
string
The name of the project this field is defined in.
requires_refresh_on_sort
boolean
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
string
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
boolean
Whether this field can be sorted.
source_file
string
The path portion of source_file_path.
source_file_path
string
The fully-qualified path of the project file this field is defined in.
sql
string
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.
suggest_dimension
string
The name of the dimension to base suggest queries from.
suggest_explore
string
The name of the explore to base suggest queries from.
suggestable
boolean
Whether or not suggestions are possible for this field.
suggestions
string[]
tags
string[]
type
string
The LookML type of the field.
user_attribute_filter_types
string[]
value_format
string
If specified, the LookML value format string for formatting values of this field.
view
string
The name of the view this field belongs to.
view_label
string
The human-readable label of the view the field belongs to.
dynamic
boolean
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
string
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
integer
The number of times this field has been used in queries
original_view
string
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.
Expand LookmlModelExploreField definition...
align
string
The appropriate horizontal text alignment the values of this field should be displayed in. Valid values are: "left", "right".
can_filter
boolean
Whether it's possible to filter on this field.
category
string
Field category Valid values are: "parameter", "filter", "measure", "dimension".
default_filter_value
string
The default value that this field uses when filtering. Null if there is no default value.
description
string
Description
dimension_group
string
Dimension group if this field is part of a dimension group. If not, this will be null.
drill_fields
string[]
error
string
An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
field_group_label
string
A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
field_group_variant
string
When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
fill_style
string
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
integer
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
boolean
Whether this field has a set of allowed_values specified in LookML.
has_drills_metadata
boolean
Whether this field has links or drill fields defined.
hidden
boolean
Whether this field should be hidden from the user interface.
is_filter
boolean
Whether this field is a filter.
is_fiscal
boolean
Whether this field represents a fiscal time value.
is_numeric
boolean
Whether this field is of a type that represents a numeric value.
is_timeframe
boolean
Whether this field is of a type that represents a time value.
can_time_filter
boolean
Whether this field can be time filtered.
time_interval
Details on the time interval this field represents, if it is_timeframe.
label
string
Fully-qualified human-readable label of the field.
label_from_parameter
string
The name of the parameter that will provide a parameterized label for this field, if available in the current context.
label_short
string
The human-readable label of the field, without the view label.
lookml_link
string
A URL linking to the definition of this field in the LookML IDE.
links
map_layer
If applicable, a map layer this field is associated with.
measure
boolean
Whether this field is a measure.
name
string
Fully-qualified name of the field.
strict_value_format
boolean
If yes, the field will not be localized with the user attribute number_format. Defaults to no
parameter
boolean
Whether this field is a parameter.
permanent
boolean
Whether this field can be removed from a query.
primary_key
boolean
Whether or not the field represents a primary key.
project_name
string
The name of the project this field is defined in.
requires_refresh_on_sort
boolean
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
string
The LookML scope this field belongs to. The scope is typically the field's view.
sortable
boolean
Whether this field can be sorted.
source_file
string
The path portion of source_file_path.
source_file_path
string
The fully-qualified path of the project file this field is defined in.
sql
string
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.
suggest_dimension
string
The name of the dimension to base suggest queries from.
suggest_explore
string
The name of the explore to base suggest queries from.
suggestable
boolean
Whether or not suggestions are possible for this field.
suggestions
string[]
tags
string[]
type
string
The LookML type of the field.
user_attribute_filter_types
string[]
value_format
string
If specified, the LookML value format string for formatting values of this field.
view
string
The name of the view this field belongs to.
view_label
string
The human-readable label of the view the field belongs to.
dynamic
boolean
Whether this field was specified in "dynamic_fields" and is not part of the model.
week_start_day
string
The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
times_used
integer
The number of times this field has been used in queries
original_view
string
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.
Expand LookmlModelExploreJoins definition...
name
string
Name of this join (and name of the view to join)
dependent_fields
string[]
fields
string[]
foreign_key
string
Name of the dimension in this explore whose value is in the primary key of the joined view
from
string
Name of view to join
outer_only
boolean
Specifies whether all queries must use an outer join
relationship
string
many_to_one, one_to_one, one_to_many, many_to_many
required_joins
string[]
sql_foreign_key
string
SQL expression that produces a foreign key
sql_on
string
SQL ON expression describing the join condition
sql_table_name
string
SQL table name to join
type
string
The join type: left_outer, full_outer, inner, or cross
view_label
string
Label to display in UI selectors
group_label
string
Label used to group explores in the navigation menus
supported_measure_types
Expand LookmlModelExploreSupportedMeasureType definition...
dimension_type
string
measure_types
string[]
always_join
string[]