civis (version 1.1.0)

reports_list_snapshots: Get details about the report's snapshot automation settings

Description

Get details about the report's snapshot automation settings

Usage

reports_list_snapshots(id)

Arguments

id

integer required. The ID of this report.

Value

A list containing the following elements:

id

integer, The ID of this report.

state

string, The status of the job's last run.

finishedAt

string, The time that the job's last run finished.

sendEmailOnCompletion

boolean, Whether the job will send emails on completion.

emailTemplate

string, Custom email template.

recipientEmailAddresses

string, Email addresses to send report to, comma separated.

emailSubject

string, Subject for Email.

height

integer, The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.

width

integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.

schedule

object, A list containing the following elements:

• scheduled boolean, If the object 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

parentId

integer, The ID of the parent job that will trigger this snapshot.