Create Lookml Dashboard Render Task deprecated
Implementation Notes
Create a new task to render a lookml dashboard to a document or image.
DEPRECATED: Use create_dashboard_render_task()) in API 4.0+
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
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. Value can be one of: [“letter”,”legal”,”tabloid”,”a0”,”a1”,”a2”,”a3”,”a4”,”a5”] | 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 }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Look Render Task
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
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 }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Query Render Task
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
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 }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Dashboard Render Task
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
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. Value can be one of: [“letter”,”legal”,”tabloid”,”a0”,”a1”,”a2”,”a3”,”a4”,”a5”] | string | string |
pdf_landscape | false | Whether to render pdf in landscape paper orientation | 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 }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Render Task
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
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 |
---|---|---|
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 }
|
Render Task Results
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 |
---|---|---|
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 }
|
102 | Processing |