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
boolean
Are values formatted? (containing currency symbols, digit separators, etc.
apply_vis
boolean
Whether visualization options are applied to the results.
address
string
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
boolean
Whether the recipient is a Looker user on the current instance (only applicable for email recipients)
type
string
Type of the address ('email', 'webhook', 's3', or 'sftp')
parameters
string
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
string
(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
string
Optional message to be included in scheduled emails
run_once
boolean
Whether the plan in question should only be run once (usually for testing)
include_links
boolean
Whether links back to Looker should be included in this ScheduledPlan
custom_url_base
string
Custom url domain for the scheduled entity
custom_url_params
string
Custom url path and parameters for the scheduled entity
custom_url_label
string
Custom url label for the scheduled entity
show_custom_url
boolean
Whether to show custom link back instead of standard looker link
pdf_paper_size
string
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
boolean
Whether the PDF should be formatted for landscape orientation
embed
boolean
Whether this schedule is in an embed context or not
color_theme
string
Color scheme of the dashboard if applicable
long_tables
boolean
Whether or not to expand table vis to full length
inline_table_width
integer
The pixel width at which we render the inline table visualizations
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# ScheduledPlan\n\nVersion 4.0.25.14 (latest) \nDatatype \nDescription \n(object) \nobject \nname \nstring \nName of this scheduled plan \nuser_id \nstring \nUser Id which owns this scheduled plan \nrun_as_recipient \nboolean \nWhether schedule is run as recipient (only applicable for email recipients) \nenabled \nboolean \nWhether the ScheduledPlan is enabled \nlook_id \nstring \nId of a look \ndashboard_id \nstring \nId of a dashboard \nlookml_dashboard_id \nstring \nId of a LookML dashboard \nfilters_string \nstring \nQuery string to run look or dashboard with \ndashboard_filters \nstring \n(DEPRECATED) Alias for filters_string field \nrequire_results \nboolean \nDelivery should occur if running the dashboard or look returns results \nrequire_no_results \nboolean \nDelivery should occur if the dashboard look does not return results \nrequire_change \nboolean \nDelivery should occur if data have changed since the last run \nsend_all_results \nboolean \nWill run an unlimited query and send all results. \ncrontab \nstring \nVixie-Style crontab specification when to run \ndatagroup \nstring \nName of a datagroup; if specified will run when datagroup triggered (can't be used with cron string) \ntimezone \nstring \nTimezone for interpreting the specified crontab (default is Looker instance timezone) \nscheduled_plan_destination \n[ScheduledPlanDestination](/looker/docs/reference/looker-api/latest/types/ScheduledPlanDestination)\\[\\] \nExpand ScheduledPlanDestination definition... \nid \n*lock* \nstring \nUnique Id \nscheduled_plan_id \nstring \nId of a scheduled plan you own \nformat \nstring \nThe 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\" \napply_formatting \nboolean \nAre values formatted? (containing currency symbols, digit separators, etc. \napply_vis \nboolean \nWhether visualization options are applied to the results. \naddress \nstring \nAddress 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/'. \nlooker_recipient \n*lock* \nboolean \nWhether the recipient is a Looker user on the current instance (only applicable for email recipients) \ntype \nstring \nType of the address ('email', 'webhook', 's3', or 'sftp') \nparameters \nstring \nJSON 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. \nsecret_parameters \nstring \n(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. \nmessage \nstring \nOptional message to be included in scheduled emails \nrun_once \nboolean \nWhether the plan in question should only be run once (usually for testing) \ninclude_links \nboolean \nWhether links back to Looker should be included in this ScheduledPlan \ncustom_url_base \nstring \nCustom url domain for the scheduled entity \ncustom_url_params \nstring \nCustom url path and parameters for the scheduled entity \ncustom_url_label \nstring \nCustom url label for the scheduled entity \nshow_custom_url \nboolean \nWhether to show custom link back instead of standard looker link \npdf_paper_size \nstring \nThe size of paper the PDF should be formatted to fit. Valid values are: \"letter\", \"legal\", \"tabloid\", \"a0\", \"a1\", \"a2\", \"a3\", \"a4\", \"a5\". \npdf_landscape \nboolean \nWhether the PDF should be formatted for landscape orientation \nembed \nboolean \nWhether this schedule is in an embed context or not \ncolor_theme \nstring \nColor scheme of the dashboard if applicable \nlong_tables \nboolean \nWhether or not to expand table vis to full length \ninline_table_width \ninteger \nThe pixel width at which we render the inline table visualizations \nquery_id \nstring \nQuery id \nid \n*lock* \nstring \nUnique Id \ncreated_at \n*lock* \nstring \nDate and time when ScheduledPlan was created \nupdated_at \n*lock* \nstring \nDate and time when ScheduledPlan was last updated \ntitle \n*lock* \nstring \nTitle \nuser \n*lock* \n[UserPublic](/looker/docs/reference/looker-api/latest/types/UserPublic) \nUser who owns this ScheduledPlan\nExpand UserPublic definition... \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \nid \n*lock* \nstring \nUnique Id \nfirst_name \n*lock* \nstring \nFirst Name \nlast_name \n*lock* \nstring \nLast Name \ndisplay_name \n*lock* \nstring \nFull name for display (available only if both first_name and last_name are set) \navatar_url \n*lock* \nstring \nURL for the avatar image (may be generic) \nurl \n*lock* \nstring \nLink to get this item \nnext_run_at \n*lock* \nstring \nWhen the ScheduledPlan will next run (null if running once) \nlast_run_at \n*lock* \nstring \nWhen the ScheduledPlan was last run \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object\n\nRelated Methods\n---------------\n\n- [ScheduledPlan/update_scheduled_plan](../methods/ScheduledPlan/update_scheduled_plan \"ScheduledPlan/update_scheduled_plan\")\n- [ScheduledPlan/scheduled_plan](../methods/ScheduledPlan/scheduled_plan \"ScheduledPlan/scheduled_plan\")\n- [ScheduledPlan/create_scheduled_plan](../methods/ScheduledPlan/create_scheduled_plan \"ScheduledPlan/create_scheduled_plan\")\n- [ScheduledPlan/scheduled_plan_run_once](../methods/ScheduledPlan/scheduled_plan_run_once \"ScheduledPlan/scheduled_plan_run_once\")\n- [ScheduledPlan/scheduled_plan_run_once_by_id](../methods/ScheduledPlan/scheduled_plan_run_once_by_id \"ScheduledPlan/scheduled_plan_run_once_by_id\")"]]
