Version 4.0.24.18
Datatype
Description
(object)
name
Name of this scheduled plan
user_id
User Id which owns this scheduled plan
run_as_recipient
Whether schedule is run as recipient (only applicable for email recipients)
enabled
Whether the ScheduledPlan is enabled
look_id
Id of a look
dashboard_id
Id of a dashboard
lookml_dashboard_id
Id of a LookML dashboard
filters_string
Query string to run look or dashboard with
dashboard_filters
(DEPRECATED) Alias for filters_string field
require_results
Delivery should occur if running the dashboard or look returns results
require_no_results
Delivery should occur if the dashboard look does not return results
require_change
Delivery should occur if data have changed since the last run
send_all_results
Will run an unlimited query and send all results.
crontab
Vixie-Style crontab specification when to run
datagroup
Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string)
timezone
Timezone for interpreting the specified crontab (default is Looker instance timezone)
scheduled_plan_destination
Expand ScheduledPlanDestination definition...
id
lock
Unique Id
scheduled_plan_id
Id of a scheduled plan you own
format
The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png"
apply_formatting
Are values formatted? (containing currency symbols, digit separators, etc.
apply_vis
Whether visualization options are applied to the results.
address
Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://example.domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'.
looker_recipient
lock
Whether the recipient is a Looker user on the current instance (only applicable for email recipients)
type
Type of the address ('email', 'webhook', 's3', or 'sftp')
parameters
JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.
secret_parameters
(Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.
message
Optional message to be included in scheduled emails
run_once
Whether the plan in question should only be run once (usually for testing)
include_links
Whether links back to Looker should be included in this ScheduledPlan
custom_url_base
Custom url domain for the scheduled entity
custom_url_params
Custom url path and parameters for the scheduled entity
custom_url_label
Custom url label for the scheduled entity
show_custom_url
Whether to show custom link back instead of standard looker link
pdf_paper_size
The size of paper the PDF should be formatted to fit. Valid values are: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".
pdf_landscape
Whether the PDF should be formatted for landscape orientation
embed
Whether this schedule is in an embed context or not
color_theme
Color scheme of the dashboard if applicable
long_tables
Whether or not to expand table vis to full length
inline_table_width
The pixel width at which we render the inline table visualizations
query_id
Query id