looker-get-parameters
A “looker-get-parameters” tool returns all the parameters from a given explore in a given model in the source.
2 minute read
About
A looker-get-parameters tool returns all the parameters from a given explore
in a given model in the source.
looker-get-parameters accepts two parameters, the model and the explore.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Looker Source |
Example
kind: tool
name: get_parameters
type: looker-get-parameters
source: looker-source
description: |
This tool retrieves a list of parameters defined within a specific Looker explore.
LookML parameters are dynamic input fields that allow users to influence query
behavior without directly modifying the underlying LookML. They are often used
with `liquid` templating to create flexible dashboards and reports, enabling
users to choose dimensions, measures, or other query components at runtime.
Parameters:
- model_name (required): The name of the LookML model, obtained from `get_models`.
- explore_name (required): The name of the explore within the model, obtained from `get_explores`.
The response is a json array with the following elements:
{
"name": "field name",
"description": "field description",
"type": "field type",
"label": "field label",
"label_short": "field short label",
"tags": ["tags", ...],
"synonyms": ["synonyms", ...],
"suggestions": ["suggestion", ...],
"suggest_explore": "explore",
"suggest_dimension": "dimension",
"value_format": "excel style format string",
"value_format_name": "named value format"
}
value_format is the Excel-style format string defined by the LookML
value_format
parameter, and value_format_name is the name of the format defined by the
LookML
value_format_name
parameter. Both keys are omitted when the field does not define them.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “looker-get-parameters”. |
| source | string | true | Name of the source the SQL should execute on. |
| description | string | true | Description of the tool that is passed to the LLM. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.