Note that you are viewing Looker documentation. For Looker Studio documentation, visit https://support.google.com/looker-studio.

Run Inline Query

Version 4.0.24.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

Request

POST /queries/run/{result_format}

Datatype

Description

Request

HTTP Request

path

HTTP Path

Expand HTTP Path definition...

result_format

string

Format of result

body

HTTP Body

Expand HTTP Body definition...

body

Query

inline query

Expand Query definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

model

string

Model

view

string

Explore Name

fields

string[]

pivots

string[]

fill_fields

string[]

filters

object

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

string

Filter Expression

sorts

string[]

limit

string

Limit

column_limit

string

Column Limit

total

boolean

Total

row_total

string

Raw Total

subtotals

string[]

vis_config

object

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

object

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

string

Visible UI Sections

slug

string

Slug

dynamic_fields

string

Dynamic Fields

client_id

string

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

string

Share Url

expanded_share_url

string

Expanded Share Url

url

string

Expanded Url

query_timezone

string

Query Timezone

has_table_calculations

boolean

Has Table Calculations

query

HTTP Query

Expand HTTP Query definition...

limit

integer

Row limit (may override the limit in the saved query).

apply_formatting

boolean

Apply model-specified formatting to each result.

apply_vis

boolean

Apply visualization options to results.

cache

boolean

Get results from cache if available.

image_width

integer

Render width for image formats.

image_height

integer

Render height for image formats.

generate_drill_links

boolean

Generate drill links (only applicable to 'json_detail' format.

force_production

boolean

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

boolean

Retrieve any results from cache even if the results have expired.

path_prefix

string

Prefix to use for drill links (url encoded).

rebuild_pdts

boolean

Rebuild PDTS used in query.

server_table_calcs

boolean

Perform table calculations on query results

Response

200: Query Result

Datatype

Description

(string)

string

400: Bad Request

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

404: Not Found

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

422: Validation Error

Datatype

Description

(object)

ValidationError

message

string

Error details

errors

ValidationErrorDetail[]

Expand ValidationErrorDetail definition...

field

string

Field with error

code

string

Error code

message

string

Error info message

documentation_url

string

Documentation link

documentation_url

string

Documentation link

429: Too Many Requests

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Examples

Run Inline Query

Run the query that is specified inline in the posted body.

Request

Response

200: Query Result

400: Bad Request

404: Not Found

422: Validation Error

429: Too Many Requests

Examples

Python

Kotlin

TSX

TypeScript