RenderTask : Manage Render Tasks

Create Look Render Task beta

POST/api/3.0/render_tasks/looks/{look_id}/{result_format}

create_look_render_task(look_id, result_format, width, height, fields)

Implementation Notes

Create a new task to render a look 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).

Response Class

RenderTask {

id (string, read-only): Id of this render task,

created_at (string, read-only): Date/Time render task was created,

finalized_at (string, read-only): Date/Time render task was completed,

status (string, read-only): Render task status: enqueued_for_query, querying, enqueued_for_render, rendering, success, failure,

status_detail (string, read-only): Additional information about the current status,

user_id (long, read-only): The user account permissions in which the render task will execute,

runtime (double, read-only): Total seconds elapsed for render task,

query_runtime (double, read-only): Number of seconds elapsed running queries,

render_runtime (double, read-only): Number of seconds elapsed rendering data,

result_format (string, read-only): Output format: pdf, png, or jpg,

look_id (long, read-only): Id of look to render,

dashboard_id (long, read-only): Id of dashboard to render,

lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,

query_id (long, read-only): Id of query to render,

width (long, read-only): Output width in pixels,

height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,

dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,

dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,

can (object, read-only): Operations the current user is able to perform on this object

}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
look_id	true	Id of look to render	integer	int64
result_format	true	Output type: png, or jpg	string	string
width	true	Output width in pixels	integer	int64
height	true	Output height in pixels	integer	int64
fields	false	Requested fields.	string	string

Response Messages

HTTP Status Code	Reason	Response Model
400	Bad Request	Error { message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
404	Not Found	Error { message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
409	Resource Already Exists	Error { message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
422	Validation Error	ValidationError { message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link } ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }

Create Query Render Task beta

POST/api/3.0/render_tasks/queries/{query_id}/{result_format}

create_query_render_task(query_id, result_format, width, height, fields)

Implementation Notes

Create a new task to render an existing query to an image.