Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KpiResourceFormat

Package version

interface

An interface representing KpiResourceFormat. The KPI resource format.

extends

ProxyResource

Hierarchy

Index

Properties

Properties

Optional aliases

aliases: KpiAlias[]
member

{KpiAlias[]} [aliases] The aliases.

calculationWindow

calculationWindow: CalculationWindowTypes
member

{CalculationWindowTypes} calculationWindow The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'

Optional calculationWindowFieldName

calculationWindowFieldName: undefined | string
member

{string} [calculationWindowFieldName] Name of calculation window field.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized description for the KPI.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the KPI.

entityType

entityType: EntityTypes
member

{EntityTypes} entityType The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

entityTypeName

entityTypeName: string
member

{string} entityTypeName The mapping entity name.

expression

expression: string
member

{string} expression The computation expression for the KPI.

Optional extracts

extracts: KpiExtract[]
member

{KpiExtract[]} [extracts] The KPI extracts.

Optional filter

filter: undefined | string
member

{string} [filter] The filter expression for the KPI.

functionProperty

functionProperty: KpiFunctions
member

{KpiFunctions} functionProperty The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'

Optional groupBy

groupBy: string[]
member

{string[]} [groupBy] the group by properties for the KPI.

Optional groupByMetadata

groupByMetadata: KpiGroupByMetadata[]
member

{KpiGroupByMetadata[]} [groupByMetadata] The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kpiName

kpiName: undefined | string
member

{string} [kpiName] The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional participantProfilesMetadata

participantProfilesMetadata: KpiParticipantProfilesMetadata[]
member

{KpiParticipantProfilesMetadata[]} [participantProfilesMetadata] The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thresHolds

thresHolds: KpiThresholds
member

{KpiThresholds} [thresHolds] The KPI thresholds.

Optional type

type: undefined | string
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

unit: undefined | string
member

{string} [unit] The unit of measurement for the KPI.

Generated using TypeDoc