Run Query Async

Version 4.0.24.6 (latest)

Create an async query task

Creates a query task (job) to run a previously created query asynchronously. Returns a Query Task ID.

Use query_task(query_task_id) to check the execution status of the query task. After the query task status reaches "Complete", use query_task_results(query_task_id) to fetch the results of the query.

Request

POST /query_tasks
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
Query parameters
Expand CreateQueryTask definition...
can
object
Operations the current user is able to perform on this object
query_id
string
Id of query to run
result_format
string
Desired async query result format. Valid values are: "inline_json", "json", "json_detail", "json_fe", "json_bi", "csv", "html", "md", "txt", "xlsx", "gsxml", "sql".
source
string
Source of query task
deferred
boolean
Create the task but defer execution
look_id
string
Id of look associated with query.
dashboard_id
string
Id of dashboard associated with query.
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.
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
fields
string
Requested fields

Response

200: query_task

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
query_id
string
Id of query
query
Query
Expand Query definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
model
string
Model
view
string
Explore Name
fields
string[]
pivots
string[]
fill_fields
string[]
filters
object
Filters
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
generate_links
boolean
whether or not to generate links in the query response.
force_production
boolean
Use production models to run query (even is user is in dev mode).
path_prefix
string
Prefix to use for drill links.
cache
boolean
Whether or not to use the cache
server_table_calcs
boolean
Whether or not to run table calculations on the server
cache_only
boolean
Retrieve any results from cache even if the results have expired.
cache_key
string
cache key used to cache query.
status
string
Status of query task.
source
string
Source of query task.
runtime
number
Runtime of prior queries.
rebuild_pdts
boolean
Rebuild PDTS used in query.
result_source
string
Source of the results of the query.
look_id
string
Id of look associated with query.
dashboard_id
string
Id of dashboard associated with query.
result_format
string
The data format of the query results.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

409: Resource Already Exists

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
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)
message
string
Error details
documentation_url
string
Documentation link

Examples