Version 4.0.26.16
Run the query that is specified inline in the posted body.
This allows running a query as defined in json in the posted body. This combines the two actions of posting & running a query into one step.
Here is an example body in json:
{
"model":"thelook",
"view":"inventory_items",
"fields":["category.name","inventory_items.days_in_inventory_tier","products.count"],
"filters":{"category.name":"socks"},
"sorts":["products.count desc 0"],
"limit":"500",
"query_timezone":"America/Los_Angeles"
}
When using the Ruby SDK this would be passed as a Ruby hash like:
{
:model=>"thelook",
:view=>"inventory_items",
:fields=>
["category.name",
"inventory_items.days_in_inventory_tier",
"products.count"],
:filters=>{:"category.name"=>"socks"},
:sorts=>["products.count desc 0"],
:limit=>"500",
:query_timezone=>"America/Los_Angeles",
}
This will return the result of running the query in the format specified by the 'result_format' parameter.
Supported formats:
| result_format | Description |
|---|---|
| json | Plain json |
| json_bi | (RECOMMENDED) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query. See JsonBi type for schema |
| json_detail | (LEGACY) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query |
| csv | Comma separated values with a header |
| txt | Tab separated values with a header |
| html | Simple html |
| md | Simple markdown |
| xlsx | MS Excel spreadsheet |
| sql | Returns the generated SQL rather than running the query |
| png | A PNG image of the visualization of the query |
| jpg | A JPG image of the visualization of the query |
Note: Streaming queries only write results to the cache when using the json_detail format. Queries in other formats only populate the cache if they cannot be streamed (such as when table calculations or row totals are present). Once cached, all result formats can retrieve results from the cache.
Request
POST
/queries/run/{result_format}
Datatype
Description
Request
path
Expand HTTP Path definition...
result_format
Format of result
body
Expand HTTP Body definition...
body
inline query
Expand Query definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
model
Model
view
Explore Name
fields
pivots
fill_fields
filters
Filters will contain data pertaining to complex filters that do not contain "or" conditions. When "or" conditions are present, filter data will be found on the `filter_expression` property.
filter_expression
Filter Expression
sorts
limit
Row limit. To download unlimited results, set the limit to -1 (negative one).
column_limit
Column Limit
total
Total
row_total
Raw Total
subtotals
vis_config
Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
filter_config
The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.
visible_ui_sections
Visible UI Sections
slug
lock
Slug
dynamic_fields
Dynamic Fields
client_id
Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.
share_url
lock
Share Url
expanded_share_url
lock
Expanded Share Url
url
lock
Expanded Url
query_timezone
Query Timezone
has_table_calculations
lock
Has Table Calculations
query
Expand HTTP Query definition...
limit
Row limit (may override the limit in the saved query).
apply_formatting
Apply model-specified formatting to each result.
apply_vis
Apply visualization options to results.
cache
Get results from cache if available.
image_width
Render width for image formats.
image_height
Render height for image formats.
generate_drill_links
Generate drill links (only applicable to 'json_detail' format.
force_production
Force use of production models even if the user is in development mode. Note that this flag being false does not guarantee development models will be used.
cache_only
Retrieve any results from cache even if the results have expired.
path_prefix
Prefix to use for drill links (url encoded).
rebuild_pdts
Rebuild PDTS used in query.
server_table_calcs
Perform table calculations on query results
Response
200: Query Result
Datatype
Description
(string)
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
403: Database OAuth Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
Kotlin
| https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/test/TestMethods.kt |
TSX
| https://github.com/looker-open-source/sdk-codegen/blob/main/packages/extension-tile-playground/src/components/DashboardTile/DashboardTile.tsx |
TypeScript