---
title: "GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi"
method: GET
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi"
tags: ["Kpi"]
---

# GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi

`GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi`

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Gets all the KPIs in the specified hub.

## Path parameters

- `resourceGroupName` string, required
- `hubName` string, required
- `subscriptionId` string, required

## Query parameters

- `api-version` string, required

## Response `200`

OK. Successfully get all the KPIs in the hub.

- KpiListResult: The response of list KPI operation.
  - `value` KpiResourceFormat[]: Results of the list operation.
    - `id` string: Resource ID.
    - `name` string: Resource name.
    - `type` string: Resource type.
    - `properties` KpiDefinition: Defines the KPI Threshold limits.
      - `entityType` 'None' | 'Profile' | 'Interaction' | 'Relationship', required: The mapping entity type.
      - `entityTypeName` string, required: The mapping entity name.
      - `tenantId` string: The hub name.
      - `kpiName` string: The KPI name.
      - `displayName` object: Localized display name for the KPI.
      - `description` object: Localized description for the KPI.
      - `calculationWindow` 'Lifetime' | 'Hour' | 'Day' | 'Week' | 'Month', required: The calculation window.
      - `calculationWindowFieldName` string: Name of calculation window field.
      - `function` 'Sum' | 'Avg' | 'Min' | 'Max' | 'Last' | 'Count' | 'None' | 'CountDistinct', required: The computation function for the KPI.
      - `expression` string, required: The computation expression for the KPI.
      - `unit` string: The unit of measurement for the KPI.
      - `filter` string: The filter expression for the KPI.
      - `groupBy` string[]: the group by properties for the KPI.
      - `groupByMetadata` KpiGroupByMetadata[]: The KPI GroupByMetadata.
        - `displayName` object: The display name.
        - `fieldName` string: The name of the field.
        - `fieldType` string: The type of the field.
      - `participantProfilesMetadata` KpiParticipantProfilesMetadata[]: The participant profiles.
        - `typeName` string, required: Name of the type.
      - `provisioningState` 'Provisioning' | 'Succeeded' | 'Expiring' | 'Deleting' | 'HumanIntervention' | 'Failed': Provisioning state.
      - `thresHolds` KpiThresholds: Defines the KPI Threshold limits.
        - `lowerLimit` number, required: The lower threshold limit.
        - `upperLimit` number, required: The upper threshold limit.
        - `increasingKpi` boolean, required: Whether or not the KPI is an increasing KPI.
      - `aliases` KpiAlias[]: The aliases.
        - `aliasName` string, required: KPI alias name.
        - `expression` string, required: The expression.
      - `extracts` KpiExtract[]: The KPI extracts.
        - `extractName` string, required: KPI extract name.
        - `expression` string, required: The expression.
  - `nextLink` string: Link to the next set of results.

---

[API](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight.md) - [All operations](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight/revisions/1a3e19f598e0?raw)
