Stay organized with collections
Save and categorize content based on your preferences.
Version 4.0.25.14 (latest)
Create a new task to render a dashboard element to an image.
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
POST
/render_tasks/dashboard_elements/{dashboard_element_id}/{result_format}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
dashboard_element_id
string
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# Create Dashboard Element Render Task\n\nVersion 4.0.25.14 (latest)\n\n### Create a new task to render a dashboard element to an image.\n\nReturns a render task object.\nTo check the status of a render task, pass the render_task.id to [Get Render Task](/looker/docs/reference/looker-api/latest/methods/RenderTask/get_render_task).\nOnce the render task is complete, you can download the resulting document or image using [Get Render Task Results](/looker/docs/reference/looker-api/latest/methods/RenderTask/get_render_task_results).\n\nRequest\n-------\n\nPOST /render_tasks/dashboard_elements/{dashboard_element_id}/{result_format} \nDatatype \nDescription \nRequest \nHTTP Request \npath \nHTTP Path \nExpand HTTP Path definition... \ndashboard_element_id \nstring \nId of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id \nresult_format \nstring \nOutput type: png or jpg \nquery \nHTTP Query \nExpand HTTP Query definition... \nwidth \ninteger \nOutput width in pixels \nheight \ninteger \nOutput height in pixels \nfields \nstring \nRequested fields.\n\nResponse\n--------\n\n### 200: Render Task\n\nDatatype \nDescription \n(object) \n[RenderTask](/looker/docs/reference/looker-api/latest/types/RenderTask) \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \ncreated_at \n*lock* \nstring \nDate/Time render task was created \ndashboard_filters \n*lock* \nstring \nFilter values to apply to the dashboard queries, in URL query format \ndashboard_id \n*lock* \nstring \nId of dashboard to render \ndashboard_style \n*lock* \nstring \nDashboard layout style: single_column or tiled \nfinalized_at \n*lock* \nstring \nDate/Time render task was completed \nheight \n*lock* \ninteger \nOutput height in pixels. Flowed layouts may ignore this value. \nid \n*lock* \nstring \nId of this render task \nlook_id \n*lock* \nstring \nId of look to render \nlookml_dashboard_id \n*lock* \nstring \nId of lookml dashboard to render \nquery_id \n*lock* \nstring \nId of query to render \ndashboard_element_id \n*lock* \nstring \nId of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id \nquery_runtime \n*lock* \nnumber \nNumber of seconds elapsed running queries \nrender_runtime \n*lock* \nnumber \nNumber of seconds elapsed rendering data \nresult_format \n*lock* \nstring \nOutput format: pdf, png, or jpg \nruntime \n*lock* \nnumber \nTotal seconds elapsed for render task \nstatus \n*lock* \nstring \nRender task status: enqueued_for_query, querying, enqueued_for_render, rendering, success, failure \nstatus_detail \n*lock* \nstring \nAdditional information about the current status \nuser_id \n*lock* \nstring \nThe user account permissions in which the render task will execute \nwidth \n*lock* \ninteger \nOutput width in pixels\n\n### 400: Bad Request\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 404: Not Found\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 409: Resource Already Exists\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 422: Validation Error\n\nDatatype \nDescription \n(object) \n[ValidationError](/looker/docs/reference/looker-api/latest/types/ValidationError) \nmessage \n*lock* \nstring \nError details \nerrors \n[ValidationErrorDetail](/looker/docs/reference/looker-api/latest/types/ValidationErrorDetail)\\[\\] \nExpand ValidationErrorDetail definition... \nfield \n*lock* \nstring \nField with error \ncode \n*lock* \nstring \nError code \nmessage \n*lock* \nstring \nError info message \ndocumentation_url \n*lock* \nstring \nDocumentation link \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 429: Too Many Requests\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link"]]
