Version 4.0.25.14 (latest)
Get Query Task details
Use this function to check the status of an async query task. After the status reaches "Complete", you can call query_task_results(query_task_id) to retrieve the results of the query.
Use create_query_task() to create an async query task.
Request
GET
/query_tasks/{query_task_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
query_task_id
string
ID of the Query Task
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.
Response
200: query_task
Datatype
Description
(object)
can
lock
object
Operations the current user is able to perform on this object
id
lock
string
Unique Id
query_id
string
Id of query
Expand Query definition...
can
lock
object
Operations the current user is able to perform on this object
id
lock
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
Row limit. To download unlimited results, set the limit to -1 (negative one).
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
lock
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
lock
string
Share Url
expanded_share_url
lock
string
Expanded Share Url
url
lock
string
Expanded Url
query_timezone
string
Query Timezone
has_table_calculations
lock
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
lock
string
cache key used to cache query.
status
string
Status of query task.
source
string
Source of query task.
runtime
lock
number
Runtime of prior queries.
rebuild_pdts
boolean
Rebuild PDTS used in query.
result_source
lock
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
lock
string
The data format of the query results.
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
Examples
Python
Ruby
| https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/stream_to_s3.rb |
|---|
| https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/stream_to_s3.rb |
