v2

latestSwagger 2.02026-07-136695189.2 KB
Profiles

Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.

post/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}/getEnrichingKpis

Path parameters

resourceGroupNamestring required

The name of the resource group.

hubNamestring required

The name of the hub.

profileNamestring required

The name of the profile.

subscriptionIdstring required

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query parameters

api-versionstring required

Client Api Version.

Response

OK. Successfully get the enriching KPIs.

entityType'None' | 'Profile' | 'Interaction' | 'Relationship' required

The mapping entity type.

entityTypeNamestring required

The mapping entity name.

tenantIdstring

The hub name.

kpiNamestring

The KPI name.

displayNameobject

Localized display name for the KPI.

descriptionobject

Localized description for the KPI.

calculationWindow'Lifetime' | 'Hour' | 'Day' | 'Week' | 'Month' required

The calculation window.

calculationWindowFieldNamestring

Name of calculation window field.

function'Sum' | 'Avg' | 'Min' | 'Max' | 'Last' | 'Count' | 'None' | 'CountDistinct' required

The computation function for the KPI.

expressionstring required

The computation expression for the KPI.

unitstring

The unit of measurement for the KPI.

filterstring

The filter expression for the KPI.

groupBystring[]

the group by properties for the KPI.

provisioningState'Provisioning' | 'Succeeded' | 'Expiring' | 'Deleting' | 'HumanIntervention' | 'Failed'

Provisioning state.