Class DatasetReportScheduleResponseAttributes

The configuration and derived state of a report schedule for a published dataset.

Hierarchy

  • DatasetReportScheduleResponseAttributes

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
cellId: null | string

The identifier of the notebook cell that published the dataset, or null if not set.

datasetId: null | string

The identifier of the dataset, or null if not set.

description: string

The description of the report.

fileRowLimit: null | number

The maximum number of rows included in the attached CSV file, or null if not set.

inlineRowLimit: null | number

The maximum number of rows included inline in the email body, or null if not set.

nextRecurrence: null | number

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

notebookId: null | number

The identifier of the notebook containing the dataset cell, or null if not set.

recipients: string[]

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

resourceId: string

The identifier of the widget containing the dataset.

The type of resource targeted by a dataset report schedule.

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).

timeframe: string

The relative timeframe of data included in the report.

timezone: string

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

title: string

The title of the report.

Generated using TypeDoc