R/generated_client.R
results_post_snapshots.Rd
Generate and optionally email a snapshot of the specified report
results_post_snapshots(id, state = NULL, finished_at = NULL, send_email_on_completion = NULL, email_template = NULL, recipient_email_addresses = NULL, email_subject = NULL, height = NULL, width = NULL, schedule = NULL, parent_id = NULL)
id | integer required. The ID of this report. |
---|---|
state | string optional. The status of the job's last run. |
finished_at | string optional. The time that the job's last run finished. |
send_email_on_completion | boolean optional. Whether the job will send emails on completion. |
email_template | string optional. Custom email template. |
recipient_email_addresses | string optional. Email addresses to send report to, comma separated. |
email_subject | string optional. Subject for Email. |
height | integer optional. The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels. |
width | integer optional. The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels. |
schedule | list optional. A list containing the following elements:
|
parent_id | integer optional. The ID of the parent job that will trigger this snapshot. |
A list containing the following elements:
integer, The ID of this report.
string, The status of the job's last run.
string, The time that the job's last run finished.
boolean, Whether the job will send emails on completion.
string, Custom email template.
string, Email addresses to send report to, comma separated.
string, Subject for Email.
integer, The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
list, A list containing the following elements:
scheduled boolean, If the item is scheduled.
scheduledDays array, Day based on numeric value starting at 0 for Sunday.
scheduledHours array, Hours of the day it is scheduled on.
scheduledMinutes array, Minutes of the day it is scheduled on.
scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour.
integer, The ID of the parent job that will trigger this snapshot.