Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FilterCycle

export
interface

FilterCycle

Hierarchy

  • FilterCycle

Index

Properties

Optional autotag

autotag: boolean
memberof

FilterCycle

Optional averageTimeToGenerate

averageTimeToGenerate: number

The average time to run the report task, in minutes

memberof

FilterCycle

Optional connectionId

connectionId: string
memberof

FilterCycle

Optional customSelection

customSelection: Array<ReportTaskCustomSelection>

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

memberof

FilterCycle

Optional dataPlatformWaitTime

dataPlatformWaitTime: number

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

memberof

FilterCycle

Optional email

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

memberof

FilterCycle

Optional enabled

enabled: boolean

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

memberof

FilterCycle

Optional endOn

endOn: string

Datetime in UTC when report task schedule will end

memberof

FilterCycle

Optional error

error: string

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

memberof

FilterCycle

Optional every

every: number | string
memberof

FilterCycle

Optional fieldInfo

memberof

FilterCycle

Optional fieldValues

fieldValues: Array<FilterCycleAllOfFieldValues>

This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.

memberof

FilterCycle

Optional filterCycleId

filterCycleId: string
memberof

FilterCycle

Optional filterSets

filterSets: Array<ReportTaskFilterSets>

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

memberof

FilterCycle

frequency

Describes the frequency of the report task's schedule

memberof

FilterCycle

Optional groupsToShareWith

groupsToShareWith: Array<ReportTaskGroupsToShareWith>

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

memberof

FilterCycle

Optional id

id: string
memberof

FilterCycle

Optional meta

meta: {}
memberof

FilterCycle

Type declaration

  • [key: string]: string

Optional nextRunAt

nextRunAt: string

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

memberof

FilterCycle

Optional selectAll

selectAll: boolean
memberof

FilterCycle

startOn

startOn: string

Datetime in UTC when report task's schedule will execute

memberof

FilterCycle

Optional tags

tags: Array<ReportTaskTags>
memberof

FilterCycle

templateId

templateId: string
memberof

FilterCycle

title

title: string

Title of the report task

memberof

FilterCycle

Optional trigger

trigger: string

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

memberof

FilterCycle

Optional variables

variables: Array<ReportTaskVariables>
memberof

FilterCycle

Generated using TypeDoc