EnrichingKpi interface

Package:

@azure/arm-customerinsights

The enriching KPI definition.

Extends

KpiDefinition

Inherited Properties

aliases	The aliases.
calculationWindow	The calculation window.
calculationWindowFieldName	Name of calculation window field.
description	Localized description for the KPI.
displayName	Localized display name for the KPI.
entityType	The mapping entity type.
entityTypeName	The mapping entity name.
expression	The computation expression for the KPI.
extracts	The KPI extracts.
filter	The filter expression for the KPI.
function	The computation function for the KPI.
groupBy	the group by properties for the KPI.
groupByMetadata	The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.
kpiName	The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.
participantProfilesMetadata	The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId	The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
thresHolds	The KPI thresholds.
unit	The unit of measurement for the KPI.

Inherited Property Details

aliases

The aliases.

aliases?: KpiAlias[]

Property Value

KpiAlias[]

Inherited From KpiDefinition.aliases

calculationWindow

The calculation window.

calculationWindow: CalculationWindowTypes

Property Value

CalculationWindowTypes

Inherited From KpiDefinition.calculationWindow

calculationWindowFieldName

Name of calculation window field.

calculationWindowFieldName?: string

Property Value

string

Inherited From KpiDefinition.calculationWindowFieldName

description

Localized description for the KPI.

description?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From KpiDefinition.description

displayName

Localized display name for the KPI.

displayName?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From KpiDefinition.displayName

entityType

The mapping entity type.

entityType: EntityTypes

Property Value

EntityTypes

Inherited From KpiDefinition.entityType

entityTypeName

The mapping entity name.

entityTypeName: string

Property Value

string

Inherited From KpiDefinition.entityTypeName

expression

The computation expression for the KPI.

expression: string

Property Value

string

Inherited From KpiDefinition.expression

extracts

The KPI extracts.

extracts?: KpiExtract[]

Property Value

KpiExtract[]

Inherited From KpiDefinition.extracts

filter

The filter expression for the KPI.

filter?: string

Property Value

string

Inherited From KpiDefinition.filter

function

The computation function for the KPI.

function: KpiFunctions

Property Value

KpiFunctions

Inherited From KpiDefinition.function

groupBy

the group by properties for the KPI.

groupBy?: string[]

Property Value

string[]

Inherited From KpiDefinition.groupBy

groupByMetadata

The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

groupByMetadata?: KpiGroupByMetadata[]

Property Value

KpiGroupByMetadata[]

Inherited From KpiDefinition.groupByMetadata

kpiName

The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

kpiName?: string

Property Value

string

Inherited From KpiDefinition.kpiName

participantProfilesMetadata

The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

participantProfilesMetadata?: KpiParticipantProfilesMetadata[]

Property Value

KpiParticipantProfilesMetadata[]

Inherited From KpiDefinition.participantProfilesMetadata

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From KpiDefinition.provisioningState

tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

Inherited From KpiDefinition.tenantId

thresHolds

The KPI thresholds.

thresHolds?: KpiThresholds

Property Value

KpiThresholds

Inherited From KpiDefinition.thresHolds

unit

The unit of measurement for the KPI.

unit?: string

Property Value

string

Inherited From KpiDefinition.unit