User Guide Getting Started Help Center Documentation Community Training
  
English
日本語
ScheduledPlan : Manage Scheduled Plans

Scheduled Plans for Space beta

GET/api/3.0/scheduled_plans/space/{space_id}
scheduled_plans_for_space(space_id, fields)

Implementation Notes

Get Scheduled Plans for a Space.

Returns scheduled plans owned by the caller for a given space id.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Space Id 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
}

Delete Scheduled Plan beta

DELETE/api/3.0/scheduled_plans/{scheduled_plan_id}
delete_scheduled_plan(scheduled_plan_id)

Implementation Notes

Delete a Scheduled Plan.

Normal users can only delete their own scheduled plans. Admins can delete other users’ scheduled plans.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
scheduled_plan_id true Scheduled Plan Id integer int64

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
}
204 Successfully deleted. string

Update Scheduled Plan beta

PATCH/api/3.0/scheduled_plans/{scheduled_plan_id}
update_scheduled_plan(scheduled_plan_id, body)

Implementation Notes

Update a Scheduled Plan.

Admins can update other users’ Scheduled Plans.

Note: Any scheduled plan destinations specified in an update will replace all scheduled plan destinations currently defined for the scheduled plan.

For Example: If a scheduled plan has destinations A, B, and C, and you call update on this scheduled plan specifying only B in the destinations, then destinations A and C will be deleted by the update.

Scheduled plan destinations must specify the data format to produce and send to the destination

Scheduled Plan Destination formats:

format Description
json A JSON object containing a data property which contains an array of JSON objects, one per row. No metadata.
json_detail Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
inline_json Same as the JSON format, except that the data property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn’t have to re-encode the JSON row data in order to pass it on to its ultimate destination.
csv Comma separated values with a header
txt Tab separated values with a header
html Simple html
xlsx MS Excel spreadsheet
wysiwyg_pdf Dashboard rendered in a tiled layout to produce a PDF document
assembled_pdf Dashboard rendered in a single column layout to produce a PDF document
wysiwyg_png Dashboard rendered in a tiled layout to produce a PNG image

Valid formats vary by destination type and source object. wysiwyg_pdf is only valid for dashboards, for example.

Response Class

ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
scheduled_plan_id true Scheduled Plan Id integer int64
body true Scheduled Plan body
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

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
}
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 Scheduled Plan beta

GET/api/3.0/scheduled_plans/{scheduled_plan_id}
scheduled_plan(scheduled_plan_id, fields)

Implementation Notes

Get Information About a Scheduled Plan.

Admins can fetch information about other users’ Scheduled Plans.

Response Class

ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
scheduled_plan_id true Scheduled Plan Id 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
}

Create Scheduled Plan beta

POST/api/3.0/scheduled_plans
create_scheduled_plan(body)

Implementation Notes

Create a Scheduled Plan.

Create a scheduled plan to render a Look or Dashboard on a recurring schedule.

The queries that provide the data for the look or dashboard are run in the context of user account that owns the scheduled plan.

Admins can create scheduled plans on behalf of other users by specifying a user id.

Scheduled plan destinations must specify the data format to produce and send to the destination

Scheduled Plan Destination formats:

format Description
json A JSON object containing a data property which contains an array of JSON objects, one per row. No metadata.
json_detail Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
inline_json Same as the JSON format, except that the data property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn’t have to re-encode the JSON row data in order to pass it on to its ultimate destination.
csv Comma separated values with a header
txt Tab separated values with a header
html Simple html
xlsx MS Excel spreadsheet
wysiwyg_pdf Dashboard rendered in a tiled layout to produce a PDF document
assembled_pdf Dashboard rendered in a single column layout to produce a PDF document
wysiwyg_png Dashboard rendered in a tiled layout to produce a PNG image

Valid formats vary by destination type and source object. wysiwyg_pdf is only valid for dashboards, for example.

Response Class

ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Scheduled Plan body
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 All Scheduled Plans beta

GET/api/3.0/scheduled_plans
all_scheduled_plans(user_id, fields)

Implementation Notes

Get All Scheduled Plans.

Returns all scheduled plans owned by the caller or given user.

If no user_id is provided, this function returns the scheduled plans owned by the caller.

The caller must have see_schedules permission to see other users’ scheduled plans.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
user_id false User Id (default is requesting user if not specified) 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
}

Run Scheduled Plan Once beta

POST/api/3.0/scheduled_plans/run_once
scheduled_plan_run_once(body)

Implementation Notes

Run a Scheduled Plan Immediately.

Create a scheduled plan that runs only once, and immediately.

This can be useful for testing a Scheduled Plan before committing to a production schedule.

Admins can create scheduled plans on behalf of other users by specifying a user id.

Scheduled plan destinations must specify the data format to produce and send to the destination

Scheduled Plan Destination formats:

format Description
json A JSON object containing a data property which contains an array of JSON objects, one per row. No metadata.
json_detail Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
inline_json Same as the JSON format, except that the data property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn’t have to re-encode the JSON row data in order to pass it on to its ultimate destination.
csv Comma separated values with a header
txt Tab separated values with a header
html Simple html
xlsx MS Excel spreadsheet
wysiwyg_pdf Dashboard rendered in a tiled layout to produce a PDF document
assembled_pdf Dashboard rendered in a single column layout to produce a PDF document
wysiwyg_png Dashboard rendered in a tiled layout to produce a PNG image

Valid formats vary by destination type and source object. wysiwyg_pdf is only valid for dashboards, for example.

Response Class

ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Scheduled Plan body
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
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,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): 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://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): 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,
can (object, read-only): Operations the current user is able to perform on this object
}

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
}

Scheduled Plans for Look beta

GET/api/3.0/scheduled_plans/look/{look_id}
scheduled_plans_for_look(look_id, user_id, fields)

Implementation Notes

Get Scheduled Plans for a Look.

Returns all scheduled plans owned by the caller or given user, for a given look.

If no user_id is provided, this function returns the scheduled plans owned by the caller.

The caller must have see_schedules permission to see other users’ scheduled plans.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
look_id true Look Id integer int64
user_id false User Id (default is requesting user if not specified) 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
}

Scheduled Plans for Dashboard beta

GET/api/3.0/scheduled_plans/dashboard/{dashboard_id}
scheduled_plans_for_dashboard(dashboard_id, user_id, fields)

Implementation Notes

Get Scheduled Plans for a Dashboard.

Returns all scheduled plans owned by the caller or given user, for a given dashboard.

If no user_id is provided, this function returns the scheduled plans owned by the caller.

The caller must have see_schedules permission to see other users’ scheduled plans.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_id true Dashboard Id integer int64
user_id false User Id (default is requesting user if not specified) 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
}

Scheduled Plans for LookML Dashboard beta

GET/api/3.0/scheduled_plans/lookml_dashboard/{lookml_dashboard_id}
scheduled_plans_for_lookml_dashboard(lookml_dashboard_id, user_id, fields)

Implementation Notes

Get Scheduled Plans for a LookML Dashboard.

Returns all scheduled plans owned by the caller or given user, for a given LookML dashboard.

If no user_id is provided, this function returns the scheduled plans owned by the caller.

The caller must have see_schedules permission to see other users’ scheduled plans.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
lookml_dashboard_id true LookML Dashboard Id integer int64
user_id false User Id (default is requesting user if not specified) 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
}
Top