Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReportTaskRequest

export
interface

ReportTaskRequest

Hierarchy

  • ReportTaskRequest

Index

Properties

Optional averageTimeToGenerate

averageTimeToGenerate: number

The average time to run the report task, in minutes

memberof

ReportTaskRequest

Optional confirmedEmailRecipients

confirmedEmailRecipients: boolean

Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.

memberof

ReportTaskRequest

Optional customSelection

customSelection: Array<ReportTaskCustomSelection>

Custom filters to apply. This field will be updated entirely if provided

memberof

ReportTaskRequest

Optional dataPlatformWaitTime

dataPlatformWaitTime: number

The time spent waiting on data platform responses during the last report task execution, in minutes

memberof

ReportTaskRequest

Optional email

Denotes whether the generated report should be emailed to its users or groups after a successful run

memberof

ReportTaskRequest

Optional emailRecipients

emailRecipients: Array<string>

Emails to send the report to. This is only allowed if "Allow reports to be shared with any email" is to true.

memberof

ReportTaskRequest

Optional enabled

enabled: boolean

Denotes whether the report task will go into the report processing queue

memberof

ReportTaskRequest

Optional endOn

endOn: string

Datetime in UTC when report task schedule will end

memberof

ReportTaskRequest

Optional error

error: string

The error object from the last report task execution, if applicable

memberof

ReportTaskRequest

Optional every

every: number | string
memberof

ReportTaskRequest

Optional filterCycleId

filterCycleId: string
memberof

ReportTaskRequest

Optional filterSets

filterSets: Array<ReportTaskFilterSets>

Array of objects denoting filter sets to apply to the report task

memberof

ReportTaskRequest

frequency

Describes the frequency of the report task's schedule

memberof

ReportTaskRequest

Optional groupsToShareWith

groupsToShareWith: Array<ReportTaskGroupsToShareWith>

Groups to share the published report with. This field will be updated entirely if provided

memberof

ReportTaskRequest

Optional id

id: string
memberof

ReportTaskRequest

Optional meta

meta: {}
memberof

ReportTaskRequest

Type declaration

  • [key: string]: string

Optional nextRunAt

nextRunAt: string

Calculated datetime in UTC when the report task will run next, if applicable

memberof

ReportTaskRequest

startOn

startOn: string

Datetime in UTC when report task's schedule will execute

memberof

ReportTaskRequest

Optional tags

tags: Array<ReportTaskTags>
memberof

ReportTaskRequest

templateId

templateId: string
memberof

ReportTaskRequest

title

title: string

Title of the report task

memberof

ReportTaskRequest

Optional trigger

trigger: string

The trigger name for the report task. Used to execute tasks on a trigger

memberof

ReportTaskRequest

Optional usersToShareWith

Users to share the published report with. This field will be updated entirely if provided

memberof

ReportTaskRequest

Optional variables

variables: Array<ReportTaskVariables>
memberof

ReportTaskRequest

Generated using TypeDoc