Dashboards Render

Dashboards Render

Certified

Render a Looker dashboard to PDF or image

Enqueues a dashboard render task in Looker, polls until rendering finishes, and stores the rendered file in Kestra storage.

yaml
type: io.kestra.plugin.looker.dashboards.Render

Render a dashboard to PDF

yaml
id: looker_render_dashboard
namespace: company.team

tasks:
  - id: render_pdf
    type: io.kestra.plugin.looker.dashboards.Render
    baseUrl: https://company.cloud.looker.com
    clientId: "{{ secret('LOOKER_CLIENT_ID') }}"
    clientSecret: "{{ secret('LOOKER_CLIENT_SECRET') }}"
    dashboardId: "12"
    format: PDF
    pdfPaperSize: "a4"
    pdfLandscape: true
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-looker --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

The base URL of the Looker instance

The Looker API client ID

The Looker API client secret

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Dashboard filter expression to apply

The ID of the dashboard to render

DefaultPDF
Possible Values
PDFPNGJPG

Output file format

Height of the rendered canvas in pixels

The ID of the saved Look to render instead of a dashboard

Whether to render PDF in landscape orientation

Paper size for PDF format (e.g. letter, legal, a4)

DefaultPT1S

Polling interval while waiting for render completion

DefaultPT5M

Maximum duration to wait for render completion

Width of the rendered canvas in pixels

The final status of the render task

The render task ID from Looker

Formaturi

URI of the rendered file in Kestra internal storage