Read a KPI Type (ARM)

[This topic is pre-release documentation and is subject to change.]

Reads the specified KPI type for a hub.

Request

The request is constructed as follows:

HTTP Verb Request URI
GET https://management.azure.com/subscriptions/<subId>/resourceGroups/<rgName>/providers/Microsoft.CustomerInsights/hubs/<hubName>/kpi/<KpiName>?api-version=2017-04-26

URI Parameters

URI Parameter Required Description
subId Yes Subscription ID
rgName Yes Azure region name
hubName Yes Name of your Customer Insights Hub
KpiName Yes Name of the KPI to retrieve

Response

The response includes a standard HTTP status code, a set of standard response headers, and a response body.

Status Code

  • 200 (OK) - The request completed successfully.

Response Body

The requested link information, containing a KPI type definition, of the form:

{
     'id':'/subscriptions/<subId>/resourceGroups/<rgName>/providers/Microsoft.CustomerInsights/hubs/<hubName>/kpi/<kpiName>'
     'name':'<hubName>/<kpiName>,
     'type':'Microsoft.CustomerInsights/hubs/kpi',
     'properties' : <KPI-Definition>
  }