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 {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (string, read-only): Date/Time render task was created,
dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,
dashboard_id (long, read-only): Id of dashboard to render,
dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,
finalized_at (string, read-only): Date/Time render task was completed,
height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,
id (string, read-only): Id of this render task,
look_id (long, read-only): Id of look to render,
lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,
query_id (long, read-only): Id of query to render,
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,
runtime (double, read-only): Total seconds elapsed for render task,
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,
width (long, read-only): Output width in pixels
}
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.
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 {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (string, read-only): Date/Time render task was created,
dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,
dashboard_id (long, read-only): Id of dashboard to render,
dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,
finalized_at (string, read-only): Date/Time render task was completed,
height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,
id (string, read-only): Id of this render task,
look_id (long, read-only): Id of look to render,
lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,
query_id (long, read-only): Id of query to render,
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,
runtime (double, read-only): Total seconds elapsed for render task,
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,
width (long, read-only): Output width in pixels
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| query_id | true | Id of the query 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 Dashboard Render Task beta
POST/api/3.0/render_tasks/dashboards/{dashboard_id}/{result_format}
create_dashboard_render_task(dashboard_id, result_format, body, width, height, fields, pdf_paper_size, pdf_landscape)
Implementation Notes
Create a new task to render a dashboard to a document or 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 {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (string, read-only): Date/Time render task was created,
dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,
dashboard_id (long, read-only): Id of dashboard to render,
dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,
finalized_at (string, read-only): Date/Time render task was completed,
height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,
id (string, read-only): Id of this render task,
look_id (long, read-only): Id of look to render,
lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,
query_id (long, read-only): Id of query to render,
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,
runtime (double, read-only): Total seconds elapsed for render task,
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,
width (long, read-only): Output width in pixels
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| dashboard_id | true | Id of dashboard to render | integer | int64 |
| result_format | true | Output type: pdf, png, or jpg | string | string |
| body | true | Dashboard render task parameters | body |
CreateDashboardRenderTask {
dashboard_filters (string): Filter values to apply to the dashboard queries, in URL query format, dashboard_style (string): Dashboard layout style: single_column or tiled }
|
| width | true | Output width in pixels | integer | int64 |
| height | true | Output height in pixels | integer | int64 |
| fields | false | Requested fields. | string | string |
| pdf_paper_size | false | Paper size for pdf | string | string |
| pdf_landscape | false | Whether to render pdf in landscape | boolean | boolean |
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 Lookml Dashboard Render Task beta
POST/api/3.0/render_tasks/lookml_dashboards/{dashboard_id}/{result_format}
create_lookml_dashboard_render_task(dashboard_id, result_format, body, width, height, fields, pdf_paper_size, pdf_landscape)
Implementation Notes
Create a new task to render a lookml dashboard to a document or 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 {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (string, read-only): Date/Time render task was created,
dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,
dashboard_id (long, read-only): Id of dashboard to render,
dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,
finalized_at (string, read-only): Date/Time render task was completed,
height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,
id (string, read-only): Id of this render task,
look_id (long, read-only): Id of look to render,
lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,
query_id (long, read-only): Id of query to render,
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,
runtime (double, read-only): Total seconds elapsed for render task,
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,
width (long, read-only): Output width in pixels
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| dashboard_id | true | Id of lookml dashboard to render | string | string |
| result_format | true | Output type: pdf, png, or jpg | string | string |
| body | true | Dashboard render task parameters | body |
CreateDashboardRenderTask {
dashboard_filters (string): Filter values to apply to the dashboard queries, in URL query format, dashboard_style (string): Dashboard layout style: single_column or tiled }
|
| width | true | Output width in pixels | integer | int64 |
| height | true | Output height in pixels | integer | int64 |
| fields | false | Requested fields. | string | string |
| pdf_paper_size | false | Paper size for pdf | string | string |
| pdf_landscape | false | Whether to render pdf in landscape | boolean | boolean |
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 }
|
Get Render Task beta
GET/api/3.0/render_tasks/{render_task_id}
render_task(render_task_id, fields)
Implementation Notes
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).
Response Class
RenderTask {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (string, read-only): Date/Time render task was created,
dashboard_filters (string, read-only): Filter values to apply to the dashboard queries, in URL query format,
dashboard_id (long, read-only): Id of dashboard to render,
dashboard_style (string, read-only): Dashboard layout style: single_column or tiled,
finalized_at (string, read-only): Date/Time render task was completed,
height (long, read-only): Output height in pixels. Flowed layouts may ignore this value.,
id (string, read-only): Id of this render task,
look_id (long, read-only): Id of look to render,
lookml_dashboard_id (string, read-only): Id of lookml dashboard to render,
query_id (long, read-only): Id of query to render,
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,
runtime (double, read-only): Total seconds elapsed for render task,
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,
width (long, read-only): Output width in pixels
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| render_task_id | true | Id of render task | string | string |
| fields | false | Requested fields. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Render Task Results beta
GET/api/3.0/render_tasks/{render_task_id}/results
render_task_results(render_task_id)
Implementation Notes
Get the document or image produced by a completed render task.
Returns 102 Processing if the render task has not completed.
Response Class
string
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| render_task_id | true | Id of render task | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 102 | Processing | |
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|