Class PrintReportRequestAttributes

The configuration for a print-only report. Specify exactly one of timeframe (for a relative time window) or both from_ts and to_ts (for an absolute time range).

Hierarchy

  • PrintReportRequestAttributes

Constructors

constructor

Properties

additionalProperties? fromTs? resourceId resourceType templateVariables timeframe? timezone toTs?

Constructors

constructor

Properties

Optional additionalProperties

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

Optional fromTs

fromTs?: number

The start of an absolute time range, as a Unix timestamp in milliseconds. Required when timeframe is omitted.

resourceId

resourceId: string

The identifier of the dashboard or integration dashboard to render.

resourceType

resourceType: ReportScheduleResourceType

The type of dashboard resource the report schedule targets.

templateVariables

templateVariables: ReportScheduleTemplateVariable[]

The dashboard template variables applied when rendering the report.

Optional timeframe

timeframe?: string

A relative time window (for example 1w or calendar_month). Mutually exclusive with from_ts and to_ts.

timezone

timezone: string

The IANA time zone identifier used to evaluate the time window.

Optional toTs

toTs?: number

The end of an absolute time range, as a Unix timestamp in milliseconds. Required when timeframe is omitted.

Settings

Member Visibility

Theme

Generated using TypeDoc