Version 4.0.25.2 (latest)
Get information about a render task.
Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.
Request
GET
/render_tasks/{render_task_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
render_task_id
Id of render task
query
Expand HTTP Query definition...
fields
Requested fields.
Response
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
created_at
lock
Date/Time render task was created
dashboard_filters
lock
Filter values to apply to the dashboard queries, in URL query format
dashboard_id
lock
Id of dashboard to render
dashboard_style
lock
Dashboard layout style: single_column or tiled
finalized_at
lock
Date/Time render task was completed
height
lock
Output height in pixels. Flowed layouts may ignore this value.
id
lock
Id of this render task
look_id
lock
Id of look to render
lookml_dashboard_id
lock
Id of lookml dashboard to render
query_id
lock
Id of query to render
dashboard_element_id
lock
Id of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id
query_runtime
lock
Number of seconds elapsed running queries
render_runtime
lock
Number of seconds elapsed rendering data
result_format
lock
Output format: pdf, png, or jpg
runtime
lock
Total seconds elapsed for render task
status
lock
Render task status: enqueued_for_query, querying, enqueued_for_render, rendering, success, failure
status_detail
lock
Additional information about the current status
user_id
lock
The user account permissions in which the render task will execute
width
lock
Output width in pixels
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples