Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReportTaskResponse

export
interface

ReportTaskResponse

Hierarchy

  • ReportTaskResponse

Index

Properties

Optional averageTimeToGenerate

averageTimeToGenerate: number

The average time to run the report task, in minutes

memberof

ReportTaskResponse

Optional customSelection

customSelection: Array<ReportTaskCustomSelection>

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

memberof

ReportTaskResponse

Optional dataPlatformWaitTime

dataPlatformWaitTime: number

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

memberof

ReportTaskResponse

Optional email

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

memberof

ReportTaskResponse

Optional enabled

enabled: boolean

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

memberof

ReportTaskResponse

Optional endOn

endOn: string

Datetime in UTC when report task schedule will end

memberof

ReportTaskResponse

Optional error

error: string

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

memberof

ReportTaskResponse

Optional every

every: number | string
memberof

ReportTaskResponse

Optional filterCycleId

filterCycleId: string
memberof

ReportTaskResponse

Optional filterSets

filterSets: Array<ReportTaskFilterSets>

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

memberof

ReportTaskResponse

frequency

Describes the frequency of the report task's schedule

memberof

ReportTaskResponse

Optional groupsToShareWith

groupsToShareWith: Array<ReportTaskGroupsToShareWith>

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

memberof

ReportTaskResponse

Optional id

id: string
memberof

ReportTaskResponse

Optional meta

meta: {}
memberof

ReportTaskResponse

Type declaration

  • [key: string]: string

Optional nextRunAt

nextRunAt: string

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

memberof

ReportTaskResponse

startOn

startOn: string

Datetime in UTC when report task's schedule will execute

memberof

ReportTaskResponse

Optional tags

tags: Array<ReportTaskTags>
memberof

ReportTaskResponse

templateId

templateId: string
memberof

ReportTaskResponse

title

title: string

Title of the report task

memberof

ReportTaskResponse

Optional trigger

trigger: string

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

memberof

ReportTaskResponse

Optional usersToShareWith

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

memberof

ReportTaskResponse

Optional variables

variables: Array<ReportTaskVariables>
memberof

ReportTaskResponse

Generated using TypeDoc