Class ReportScheduleResponseAttributes

The configuration and derived state of a report schedule.

Hierarchy

  • ReportScheduleResponseAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

The delivery format for dashboard report schedules, or null if not set.

description: string

The description of the report.

nextRecurrence: null | number

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

recipients: string[]

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

resourceId: string

The identifier of the resource rendered in the report.

The type of dashboard resource the report schedule targets.

rrule: string

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

Whether the schedule is currently delivering reports (active) or paused (inactive).

tabId: null | string

The identifier of the dashboard tab rendered in the report, or null if not set.

templateVariables: ReportScheduleTemplateVariable[]

The dashboard template variables applied when rendering the report.

timeframe: null | string

The relative timeframe of data included in the report, or null if not set.

timezone: string

The IANA time zone identifier the recurrence rule is evaluated in.

title: string

The title of the report.

Generated using TypeDoc