Microsoft Azure Kpi API

openapi: 3.2.0
info:
  title: Microsoft Azure CustomerInsightsManagementClient Kpi API
  description: The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
  version: '2017-04-26'
  x-ms-code-generation-settings:
    name: CustomerInsightsManagementClient
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Kpi
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
  : put:
      tags:
      - Kpi
      operationId: microsoftAzureKpiCreateorupdate
      x-ms-examples:
        Kpi_CreateOrUpdate:
          $ref: ./examples/KpiCreateOrUpdate.json
      description: Creates a KPI or updates an existing KPI in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: kpiName
        in: path
        required: true
        description: The name of the KPI.
        schema:
          type: string
          maxLength: 512
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_]+$
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the KPI.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KpiResourceFormat'
        '202':
          description: Accepted. The create KPI operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KpiResourceFormat'
        description: Parameters supplied to the create/update KPI operation.
        required: true
    get:
      tags:
      - Kpi
      operationId: microsoftAzureKpiGet
      x-ms-examples:
        Kpi_Get:
          $ref: ./examples/KpiGet.json
      description: Gets a KPI in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: kpiName
        in: path
        required: true
        description: The name of the KPI.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the KPI.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KpiResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - Kpi
      operationId: microsoftAzureKpiDelete
      x-ms-examples:
        Kpi_Delete:
          $ref: ./examples/KpiDelete.json
      description: Deletes a KPI in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: kpiName
        in: path
        required: true
        description: The name of the KPI.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The KPI is deleted.
        '202':
          description: Accepted. The delete operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}/reprocess
  : post:
      tags:
      - Kpi
      operationId: microsoftAzureKpiReprocess
      x-ms-examples:
        Kpi_Reprocess:
          $ref: ./examples/KpiReprocess.json
      description: Reprocesses the Kpi values of the specified KPI.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: kpiName
        in: path
        required: true
        description: The name of the KPI.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '202':
          description: Accepted. Reprocessing Kpi Values operation is accepted.
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi:
    get:
      tags:
      - Kpi
      operationId: microsoftAzureKpiListbyhub
      x-ms-examples:
        Kpi_ListByHub:
          $ref: ./examples/KpiListByHub.json
      description: Gets all the KPIs in the specified hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get all the KPIs in the hub.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KpiListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProvisioningState:
      type: string
      enum:
      - Provisioning
      - Succeeded
      - Expiring
      - Deleting
      - HumanIntervention
      - Failed
      x-ms-enum:
        name: ProvisioningStates
        modelAsString: true
      description: Provisioning state.
    KpiGroupByMetadata:
      properties:
        displayName:
          type: object
          additionalProperties:
            type: string
          description: The display name.
        fieldName:
          type: string
          description: The name of the field.
        fieldType:
          type: string
          description: The type of the field.
      description: The KPI GroupBy field metadata.
    KpiThresholds:
      properties:
        lowerLimit:
          type: number
          format: decimal
          description: The lower threshold limit.
        upperLimit:
          type: number
          format: decimal
          description: The upper threshold limit.
        increasingKpi:
          type: boolean
          description: Whether or not the KPI is an increasing KPI.
      required:
      - lowerLimit
      - upperLimit
      - increasingKpi
      description: Defines the KPI Threshold limits.
    KpiDefinition:
      required:
      - entityType
      - entityTypeName
      - calculationWindow
      - function
      - expression
      properties:
        entityType:
          type: string
          enum:
          - None
          - Profile
          - Interaction
          - Relationship
          x-ms-enum:
            name: EntityTypes
            modelAsString: false
          description: The mapping entity type.
        entityTypeName:
          type: string
          description: The mapping entity name.
        tenantId:
          type: string
          readOnly: true
          description: The hub name.
        kpiName:
          type: string
          readOnly: true
          description: The KPI name.
        displayName:
          type: object
          additionalProperties:
            type: string
          description: Localized display name for the KPI.
        description:
          type: object
          additionalProperties:
            type: string
          description: Localized description for the KPI.
        calculationWindow:
          type: string
          enum:
          - Lifetime
          - Hour
          - Day
          - Week
          - Month
          x-ms-enum:
            name: CalculationWindowTypes
            modelAsString: false
          description: The calculation window.
        calculationWindowFieldName:
          type: string
          description: Name of calculation window field.
        function:
          type: string
          enum:
          - Sum
          - Avg
          - Min
          - Max
          - Last
          - Count
          - None
          - CountDistinct
          x-ms-enum:
            name: KpiFunctions
            modelAsString: false
          description: The computation function for the KPI.
        expression:
          type: string
          description: The computation expression for the KPI.
        unit:
          type: string
          description: The unit of measurement for the KPI.
        filter:
          type: string
          description: The filter expression for the KPI.
        groupBy:
          type: array
          items:
            type: string
          description: the group by properties for the KPI.
        groupByMetadata:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/KpiGroupByMetadata'
          description: The KPI GroupByMetadata.
        participantProfilesMetadata:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/KpiParticipantProfilesMetadata'
          description: The participant profiles.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          readOnly: true
          description: Provisioning state.
        thresHolds:
          $ref: '#/components/schemas/KpiThresholds'
          description: The KPI thresholds.
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/KpiAlias'
          description: The aliases.
        extracts:
          type: array
          items:
            $ref: '#/components/schemas/KpiExtract'
          description: The KPI extracts.
      description: Defines the KPI Threshold limits.
    KpiListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/KpiResourceFormat'
          description: Results of the list operation.
        nextLink:
          type: string
          description: Link to the next set of results.
      description: The response of list KPI operation.
    KpiExtract:
      required:
      - extractName
      - expression
      properties:
        extractName:
          type: string
          description: KPI extract name.
        expression:
          type: string
          description: The expression.
      description: The KPI extract.
    KpiResourceFormat:
      description: The KPI resource format.
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/KpiDefinition'
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    KpiAlias:
      required:
      - aliasName
      - expression
      properties:
        aliasName:
          type: string
          description: KPI alias name.
        expression:
          type: string
          description: The expression.
      description: The KPI alias.
    KpiParticipantProfilesMetadata:
      required:
      - typeName
      properties:
        typeName:
          type: string
          description: Name of the type.
      description: The KPI participant profile metadata.
    ProxyResource:
      properties:
        id:
          readOnly: true
          type: string
          description: Resource ID.
        name:
          readOnly: true
          type: string
          description: Resource name.
        type:
          readOnly: true
          type: string
          description: Resource type.
      x-ms-azure-resource: true
      description: Common properties of proxy resource.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.