ReportConfigDefinition interface

The definition of a report config.

Properties

dataSet

Has definition for data in this report config.

includeMonetaryCommitment

If true, report includes monetary commitment.

timeframe

The time frame for pulling data for the report. If custom, then a specific time period must be provided.

timePeriod

Has time period for pulling data for the report.

type

The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.

Property Details

dataSet

Has definition for data in this report config.

dataSet?: ReportConfigDataset

Property Value

includeMonetaryCommitment

If true, report includes monetary commitment.

includeMonetaryCommitment?: boolean

Property Value

boolean

timeframe

The time frame for pulling data for the report. If custom, then a specific time period must be provided.

timeframe: string

Property Value

string

timePeriod

Has time period for pulling data for the report.

timePeriod?: ReportConfigTimePeriod

Property Value

type

The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.

type: string

Property Value

string