Microsoft Azure

Azure Customer Insights

The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources.…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 66

Operations

  • GETOperations_List/providers/Microsoft.CustomerInsights/operations?api-version=stringLists all of the available Customer Insights REST API operations.

Hubs

  • GETHubs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName?api-version=stringGets information about the specified hub.
  • PUTHubs_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName?api-version=stringCreates a hub, or updates an existing hub.
  • DELETEHubs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName?api-version=stringDeletes the specified hub.
  • PATCHHubs_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName?api-version=stringUpdates a Hub.
  • GETHubs_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs?api-version=stringGets all the hubs in a resource group.
  • GETHubs_List/subscriptions/:subscriptionId/providers/Microsoft.CustomerInsights/hubs?api-version=stringGets all hubs in the specified subscription.

Profiles

  • GETProfiles_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/profiles/:profileName?locale-code=en-us&api-version=stringGets information about the specified profile.
  • PUTProfiles_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/profiles/:profileName?api-version=stringCreates a profile within a Hub, or updates an existing profile.
  • DELETEProfiles_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/profiles/:profileName?locale-code=en-us&api-version=stringDeletes a profile within a hub
  • GETProfiles_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/profiles?locale-code=en-us&api-version=stringGets all profile in the hub.
  • POSTProfiles_GetEnrichingKpis/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/profiles/:profileName/getEnrichingKpis?api-version=stringGets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI…

Interactions

  • GETInteractions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/interactions/:interactionName?locale-code=en-us&api-version=stringGets information about the specified interaction.
  • PUTInteractions_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/interactions/:interactionName?api-version=stringCreates an interaction or updates an existing interaction within a hub.
  • GETInteractions_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/interactions?locale-code=en-us&api-version=stringGets all interactions in the hub.
  • POSTInteractions_SuggestRelationshipLinks/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/interactions/:interactionName/suggestRelationshipLinks?api-version=stringSuggests relationships to create relationship links.

Relationships

  • GETRelationships_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationships/:relationshipName?api-version=stringGets information about the specified relationship.
  • PUTRelationships_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationships/:relationshipName?api-version=stringCreates a relationship or updates an existing relationship within a hub.
  • DELETERelationships_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationships/:relationshipName?api-version=stringDeletes a relationship within a hub.
  • GETRelationships_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationships?api-version=stringGets all relationships in the hub.

RelationshipLinks

  • GETRelationshipLinks_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationshipLinks/:relationshipLinkName?api-version=stringGets information about the specified relationship Link.
  • PUTRelationshipLinks_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationshipLinks/:relationshipLinkName?api-version=stringCreates a relationship link or updates an existing relationship link within a hub.
  • DELETERelationshipLinks_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationshipLinks/:relationshipLinkName?api-version=stringDeletes a relationship link within a hub.
  • GETRelationshipLinks_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/relationshipLinks?api-version=stringGets all relationship links in the hub.

AuthorizationPolicies

  • GETAuthorizationPolicies_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/authorizationPolicies/:authorizationPolicyName?api-version=stringGets an authorization policy in the hub.
  • PUTAuthorizationPolicies_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/authorizationPolicies/:authorizationPolicyName?api-version=stringCreates an authorization policy or updates an existing authorization policy.
  • GETAuthorizationPolicies_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/authorizationPolicies?api-version=stringGets all the authorization policies in a specified hub.
  • POSTAuthorizationPolicies_RegeneratePrimaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/authorizationPolicies/:authorizationPolicyName/regeneratePrimaryKey?api-version=stringRegenerates the primary policy key of the specified authorization policy.
  • POSTAuthorizationPolicies_RegenerateSecondaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/authorizationPolicies/:authorizationPolicyName/regenerateSecondaryKey?api-version=stringRegenerates the secondary policy key of the specified authorization policy.

Connectors

  • GETConnectors_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName?api-version=stringGets a connector in the hub.
  • PUTConnectors_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName?api-version=stringCreates a connector or updates an existing connector in the hub.
  • DELETEConnectors_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName?api-version=stringDeletes a connector in the hub.
  • GETConnectors_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors?api-version=stringGets all the connectors in the specified hub.

ConnectorMappings

  • GETConnectorMappings_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName/mappings/:mappingName?api-version=stringGets a connector mapping in the connector.
  • PUTConnectorMappings_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName/mappings/:mappingName?api-version=stringCreates a connector mapping or updates an existing connector mapping in the connector.
  • DELETEConnectorMappings_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName/mappings/:mappingName?api-version=stringDeletes a connector mapping in the connector.
  • GETConnectorMappings_ListByConnector/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/connectors/:connectorName/mappings?api-version=stringGets all the connector mappings in the specified connector.

Kpi

  • GETKpi_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/kpi/:kpiName?api-version=stringGets a KPI in the hub.
  • PUTKpi_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/kpi/:kpiName?api-version=stringCreates a KPI or updates an existing KPI in the hub.
  • DELETEKpi_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/kpi/:kpiName?api-version=stringDeletes a KPI in the hub.
  • POSTKpi_Reprocess/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/kpi/:kpiName/reprocess?api-version=stringReprocesses the Kpi values of the specified KPI.
  • GETKpi_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/kpi?api-version=stringGets all the KPIs in the specified hub.

WidgetTypes

  • GETWidgetTypes_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/widgetTypes?api-version=stringGets all available widget types in the specified hub.
  • GETWidgetTypes_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/widgetTypes/:widgetTypeName?api-version=stringGets a widget type in the specified hub.

Views

  • GETViews_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/views?api-version=string&userId=stringGets all available views for given user in the specified hub.
  • GETViews_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/views/:viewName?api-version=string&userId=stringGets a view in the hub.
  • PUTViews_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/views/:viewName?api-version=stringCreates a view or updates an existing view in the hub.
  • DELETEViews_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/views/:viewName?api-version=string&userId=stringDeletes a view in the specified hub.

Links

  • GETLinks_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/links/:linkName?api-version=stringGets a link in the hub.
  • PUTLinks_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/links/:linkName?api-version=stringCreates a link or updates an existing link in the hub.
  • DELETELinks_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/links/:linkName?api-version=stringDeletes a link in the hub.
  • GETLinks_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/links?api-version=stringGets all the links in the specified hub.

Roles

  • GETRoles_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/roles?api-version=stringGets all the roles for the hub.

RoleAssignments

  • GETRoleAssignments_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/roleAssignments?api-version=stringGets all the role assignments for the specified hub.
  • GETRoleAssignments_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/roleAssignments/:assignmentName?api-version=stringGets the role assignment in the hub.
  • PUTRoleAssignments_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/roleAssignments/:assignmentName?api-version=stringCreates or updates a role assignment in the hub.
  • DELETERoleAssignments_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/roleAssignments/:assignmentName?api-version=stringDeletes the role assignment in the hub.

Images

  • POSTImages_GetUploadUrlForEntityType/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/images/getEntityTypeImageUploadUrl?api-version=stringGets entity type (profile or interaction) image upload URL.
  • POSTImages_GetUploadUrlForData/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/images/getDataImageUploadUrl?api-version=stringGets data image upload URL.

Predictions

  • GETPredictions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName?api-version=stringGets a Prediction in the hub.
  • PUTPredictions_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName?api-version=stringCreates a Prediction or updates an existing Prediction in the hub.
  • DELETEPredictions_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName?api-version=stringDeletes a Prediction in the hub.
  • POSTPredictions_GetTrainingResults/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName/getTrainingResults?api-version=stringGets training results.
  • POSTPredictions_GetModelStatus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName/getModelStatus?api-version=stringGets model status of the prediction.
  • POSTPredictions_ModelStatus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions/:predictionName/modelStatus?api-version=stringCreates or updates the model status of prediction.
  • GETPredictions_ListByHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.CustomerInsights/hubs/:hubName/predictions?api-version=stringGets all the predictions in the specified hub.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
66 operations on 41 pathsGET 31PUT 13DELETE 11POST 10PATCH 1
Main resources
Predictions 7Hubs 6AuthorizationPolicies 5Kpi 5Profiles 5ConnectorMappings 4Connectors 4Interactions 4Links 4RelationshipLinks 4
Response formats
application/json
Description format
Swagger 2.0, API version 2017-04-26

How to test the Azure Customer Insights in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Customer Insights collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.CustomerInsights/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Customer Insights?

The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources.… It is listed under Developer tools and has 66 endpoints.

Who publishes the Azure Customer Insights?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Customer Insights?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Customer Insights?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Customer Insights have?

66 operations on 41 paths (31 GET, 13 PUT, 11 DELETE, 10 POST, 1 PATCH). The largest groups are Predictions, Hubs, AuthorizationPolicies, Kpi.

Is forking the Azure Customer Insights free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.