LookmlModelExploreField

Version 4.0.24.2 (latest)
Datatype
Description
(object)
object
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[]
Expand LookmlModelExploreFieldEnumeration definition...
label
string
Label
value
any
Value
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.
Expand LookmlModelExploreFieldTimeInterval definition...
name
string
The type of time interval this field represents a grouping of. Valid values are: "day", "hour", "minute", "second", "millisecond", "microsecond", "week", "month", "quarter", "year".
count
integer
The number of intervals this field represents a grouping of.
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
Expand LookmlFieldLink definition...
label
string
The name of the link as it would appear to users.
url
string
URL the link will go to.
icon_url
string
A URL containing an image file to display with a link.
map_layer
If applicable, a map layer this field is associated with.
Expand LookmlModelExploreFieldMapLayer definition...
url
string
URL to the map layer resource.
name
string
Name of the map layer, as defined in LookML.
feature_key
string
Specifies the name of the TopoJSON object that the map layer references. If not specified, use the first object..
property_key
string
Selects which property from the TopoJSON data to plot against. TopoJSON supports arbitrary metadata for each region. When null, the first matching property should be used.
property_label_key
string
Which property from the TopoJSON data to use to label the region. When null, property_key should be used.
projection
string
The preferred geographic projection of the map layer when displayed in a visualization that supports multiple geographic projections.
format
string
Specifies the data format of the region information. Valid values are: "topojson", "vector_tile_region".
extents_json_url
string
Specifies the URL to a JSON file that defines the geographic extents of each region available in the map layer. This data is used to automatically center the map on the available data for visualization purposes. The JSON file must be a JSON object where the keys are the mapping value of the feature (as specified by property_key) and the values are arrays of four numbers representing the west longitude, south latitude, east longitude, and north latitude extents of the region. The object must include a key for every possible value of property_key.
max_zoom_level
integer
The minimum zoom level that the map layer may be displayed at, for visualizations that support zooming.
min_zoom_level
integer
The maximum zoom level that the map layer may be displayed at, for visualizations that support zooming.
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.
Expand LookmlModelExploreFieldSqlCase definition...
value
string
SQL Case label value
condition
string
SQL Case condition expression
Expand LookmlModelExploreFieldMeasureFilters definition...
field
string
Filter field name
condition
string
Filter condition value
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.