5.0.0 • Published 5 years ago
@datafire/azure_customer_insights v5.0.0
@datafire/azure_customer_insights
Client library for CustomerInsightsManagementClient
Installation and Usage
npm install --save @datafire/azure_customer_insightslet azure_customer_insights = require('@datafire/azure_customer_insights').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});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.
Actions
Operations_List
Lists all of the available Customer Insights REST API operations.
azure_customer_insights.Operations_List({
"api-version": ""
}, context)Input
- input
object- api-version required
string: Client Api Version.
- api-version required
Output
- output OperationListResult
Hubs_List
Gets all hubs in the specified subscription.
azure_customer_insights.Hubs_List({
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- api-version required
Output
- output HubListResult
Hubs_ListByResourceGroup
Gets all the hubs in a resource group.
azure_customer_insights.Hubs_ListByResourceGroup({
"resourceGroupName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output HubListResult
Hubs_Delete
Deletes the specified hub.
azure_customer_insights.Hubs_Delete({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Hubs_Get
Gets information about the specified hub.
azure_customer_insights.Hubs_Get({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output Hub
Hubs_Update
Updates a Hub.
azure_customer_insights.Hubs_Update({
"resourceGroupName": "",
"hubName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the Hub. - parameters required Hub
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output Hub
Hubs_CreateOrUpdate
Creates a hub, or updates an existing hub.
azure_customer_insights.Hubs_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the Hub. - parameters required Hub
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output Hub
AuthorizationPolicies_ListByHub
Gets all the authorization policies in a specified hub.
azure_customer_insights.AuthorizationPolicies_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
AuthorizationPolicies_Get
Gets an authorization policy in the hub.
azure_customer_insights.AuthorizationPolicies_Get({
"resourceGroupName": "",
"hubName": "",
"authorizationPolicyName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - authorizationPolicyName required
string: The name of the policy. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
AuthorizationPolicies_CreateOrUpdate
Creates an authorization policy or updates an existing authorization policy.
azure_customer_insights.AuthorizationPolicies_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"authorizationPolicyName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - authorizationPolicyName required
string: The name of the policy. - parameters required AuthorizationPolicyResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
AuthorizationPolicies_RegeneratePrimaryKey
Regenerates the primary policy key of the specified authorization policy.
azure_customer_insights.AuthorizationPolicies_RegeneratePrimaryKey({
"resourceGroupName": "",
"hubName": "",
"authorizationPolicyName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - authorizationPolicyName required
string: The name of the policy. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output AuthorizationPolicy
AuthorizationPolicies_RegenerateSecondaryKey
Regenerates the secondary policy key of the specified authorization policy.
azure_customer_insights.AuthorizationPolicies_RegenerateSecondaryKey({
"resourceGroupName": "",
"hubName": "",
"authorizationPolicyName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - authorizationPolicyName required
string: The name of the policy. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output AuthorizationPolicy
Connectors_ListByHub
Gets all the connectors in the specified hub.
azure_customer_insights.Connectors_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ConnectorListResult
Connectors_Delete
Deletes a connector in the hub.
azure_customer_insights.Connectors_Delete({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Connectors_Get
Gets a connector in the hub.
azure_customer_insights.Connectors_Get({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ConnectorResourceFormat
Connectors_CreateOrUpdate
Creates a connector or updates an existing connector in the hub.
azure_customer_insights.Connectors_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - parameters required ConnectorResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ConnectorResourceFormat
ConnectorMappings_ListByConnector
Gets all the connector mappings in the specified connector.
azure_customer_insights.ConnectorMappings_ListByConnector({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ConnectorMappingListResult
ConnectorMappings_Delete
Deletes a connector mapping in the connector.
azure_customer_insights.ConnectorMappings_Delete({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"mappingName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - mappingName required
string: The name of the connector mapping. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ConnectorMappings_Get
Gets a connector mapping in the connector.
azure_customer_insights.ConnectorMappings_Get({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"mappingName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - mappingName required
string: The name of the connector mapping. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
ConnectorMappings_CreateOrUpdate
Creates a connector mapping or updates an existing connector mapping in the connector.
azure_customer_insights.ConnectorMappings_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"connectorName": "",
"mappingName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - connectorName required
string: The name of the connector. - mappingName required
string: The name of the connector mapping. - parameters required ConnectorMappingResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Images_GetUploadUrlForData
Gets data image upload URL.
azure_customer_insights.Images_GetUploadUrlForData({
"resourceGroupName": "",
"hubName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - parameters required GetImageUploadUrlInput
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ImageDefinition
Images_GetUploadUrlForEntityType
Gets entity type (profile or interaction) image upload URL.
azure_customer_insights.Images_GetUploadUrlForEntityType({
"resourceGroupName": "",
"hubName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - parameters required GetImageUploadUrlInput
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ImageDefinition
Interactions_ListByHub
Gets all interactions in the hub.
azure_customer_insights.Interactions_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - locale-code
string: Locale of interaction to retrieve, default is en-us. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output InteractionListResult
Interactions_Get
Gets information about the specified interaction.
azure_customer_insights.Interactions_Get({
"resourceGroupName": "",
"hubName": "",
"interactionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - interactionName required
string: The name of the interaction. - locale-code
string: Locale of interaction to retrieve, default is en-us. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output InteractionResourceFormat
Interactions_CreateOrUpdate
Creates an interaction or updates an existing interaction within a hub.
azure_customer_insights.Interactions_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"interactionName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - interactionName required
string: The name of the interaction. - parameters required InteractionResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output InteractionResourceFormat
Interactions_SuggestRelationshipLinks
Suggests relationships to create relationship links.
azure_customer_insights.Interactions_SuggestRelationshipLinks({
"resourceGroupName": "",
"hubName": "",
"interactionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - interactionName required
string: The name of the interaction. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Kpi_ListByHub
Gets all the KPIs in the specified hub.
azure_customer_insights.Kpi_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output KpiListResult
Kpi_Delete
Deletes a KPI in the hub.
azure_customer_insights.Kpi_Delete({
"resourceGroupName": "",
"hubName": "",
"kpiName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - kpiName required
string: The name of the KPI. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Kpi_Get
Gets a KPI in the hub.
azure_customer_insights.Kpi_Get({
"resourceGroupName": "",
"hubName": "",
"kpiName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - kpiName required
string: The name of the KPI. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output KpiResourceFormat
Kpi_CreateOrUpdate
Creates a KPI or updates an existing KPI in the hub.
azure_customer_insights.Kpi_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"kpiName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - kpiName required
string: The name of the KPI. - parameters required KpiResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output KpiResourceFormat
Kpi_Reprocess
Reprocesses the Kpi values of the specified KPI.
azure_customer_insights.Kpi_Reprocess({
"resourceGroupName": "",
"hubName": "",
"kpiName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - kpiName required
string: The name of the KPI. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Links_ListByHub
Gets all the links in the specified hub.
azure_customer_insights.Links_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output LinkListResult
Links_Delete
Deletes a link in the hub.
azure_customer_insights.Links_Delete({
"resourceGroupName": "",
"hubName": "",
"linkName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - linkName required
string: The name of the link. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Links_Get
Gets a link in the hub.
azure_customer_insights.Links_Get({
"resourceGroupName": "",
"hubName": "",
"linkName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - linkName required
string: The name of the link. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output LinkResourceFormat
Links_CreateOrUpdate
Creates a link or updates an existing link in the hub.
azure_customer_insights.Links_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"linkName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - linkName required
string: The name of the link. - parameters required LinkResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output LinkResourceFormat
Predictions_ListByHub
Gets all the predictions in the specified hub.
azure_customer_insights.Predictions_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output PredictionListResult
Predictions_Delete
Deletes a Prediction in the hub.
azure_customer_insights.Predictions_Delete({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Predictions_Get
Gets a Prediction in the hub.
azure_customer_insights.Predictions_Get({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output PredictionResourceFormat
Predictions_CreateOrUpdate
Creates a Prediction or updates an existing Prediction in the hub.
azure_customer_insights.Predictions_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - parameters required PredictionResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output PredictionResourceFormat
Predictions_GetModelStatus
Gets model status of the prediction.
azure_customer_insights.Predictions_GetModelStatus({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output PredictionModelStatus
Predictions_GetTrainingResults
Gets training results.
azure_customer_insights.Predictions_GetTrainingResults({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output PredictionTrainingResults
Predictions_ModelStatus
Creates or updates the model status of prediction.
azure_customer_insights.Predictions_ModelStatus({
"resourceGroupName": "",
"hubName": "",
"predictionName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - predictionName required
string: The name of the Prediction. - parameters required PredictionModelStatus
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Profiles_ListByHub
Gets all profile in the hub.
azure_customer_insights.Profiles_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - locale-code
string: Locale of profile to retrieve, default is en-us. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ProfileListResult
Profiles_Delete
Deletes a profile within a hub
azure_customer_insights.Profiles_Delete({
"resourceGroupName": "",
"hubName": "",
"profileName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - profileName required
string: The name of the profile. - locale-code
string: Locale of profile to retrieve, default is en-us. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Profiles_Get
Gets information about the specified profile.
azure_customer_insights.Profiles_Get({
"resourceGroupName": "",
"hubName": "",
"profileName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - profileName required
string: The name of the profile. - locale-code
string: Locale of profile to retrieve, default is en-us. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ProfileResourceFormat
Profiles_CreateOrUpdate
Creates a profile within a Hub, or updates an existing profile.
azure_customer_insights.Profiles_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"profileName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - profileName required
string: The name of the profile. - parameters required ProfileResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ProfileResourceFormat
Profiles_GetEnrichingKpis
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.
azure_customer_insights.Profiles_GetEnrichingKpis({
"resourceGroupName": "",
"hubName": "",
"profileName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - profileName required
string: The name of the profile. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
array- items KpiDefinition
RelationshipLinks_ListByHub
Gets all relationship links in the hub.
azure_customer_insights.RelationshipLinks_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RelationshipLinkListResult
RelationshipLinks_Delete
Deletes a relationship link within a hub.
azure_customer_insights.RelationshipLinks_Delete({
"resourceGroupName": "",
"hubName": "",
"relationshipLinkName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipLinkName required
string: The name of the relationship. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
RelationshipLinks_Get
Gets information about the specified relationship Link.
azure_customer_insights.RelationshipLinks_Get({
"resourceGroupName": "",
"hubName": "",
"relationshipLinkName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipLinkName required
string: The name of the relationship link. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
RelationshipLinks_CreateOrUpdate
Creates a relationship link or updates an existing relationship link within a hub.
azure_customer_insights.RelationshipLinks_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"relationshipLinkName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipLinkName required
string: The name of the relationship link. - parameters required RelationshipLinkResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Relationships_ListByHub
Gets all relationships in the hub.
azure_customer_insights.Relationships_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RelationshipListResult
Relationships_Delete
Deletes a relationship within a hub.
azure_customer_insights.Relationships_Delete({
"resourceGroupName": "",
"hubName": "",
"relationshipName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipName required
string: The name of the relationship. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Relationships_Get
Gets information about the specified relationship.
azure_customer_insights.Relationships_Get({
"resourceGroupName": "",
"hubName": "",
"relationshipName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipName required
string: The name of the relationship. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RelationshipResourceFormat
Relationships_CreateOrUpdate
Creates a relationship or updates an existing relationship within a hub.
azure_customer_insights.Relationships_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"relationshipName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - relationshipName required
string: The name of the Relationship. - parameters required RelationshipResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RelationshipResourceFormat
RoleAssignments_ListByHub
Gets all the role assignments for the specified hub.
azure_customer_insights.RoleAssignments_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RoleAssignmentListResult
RoleAssignments_Delete
Deletes the role assignment in the hub.
azure_customer_insights.RoleAssignments_Delete({
"resourceGroupName": "",
"hubName": "",
"assignmentName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - assignmentName required
string: The name of the role assignment. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
RoleAssignments_Get
Gets the role assignment in the hub.
azure_customer_insights.RoleAssignments_Get({
"resourceGroupName": "",
"hubName": "",
"assignmentName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - assignmentName required
string: The name of the role assignment. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RoleAssignmentResourceFormat
RoleAssignments_CreateOrUpdate
Creates or updates a role assignment in the hub.
azure_customer_insights.RoleAssignments_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"assignmentName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - assignmentName required
string: The assignment name - parameters required RoleAssignmentResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RoleAssignmentResourceFormat
Roles_ListByHub
Gets all the roles for the hub.
azure_customer_insights.Roles_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RoleListResult
Views_ListByHub
Gets all available views for given user in the specified hub.
azure_customer_insights.Views_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": "",
"userId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - userId required
string: The user ID. Use * to retrieve hub level views.
- resourceGroupName required
Output
- output ViewListResult
Views_Delete
Deletes a view in the specified hub.
azure_customer_insights.Views_Delete({
"resourceGroupName": "",
"hubName": "",
"viewName": "",
"api-version": "",
"subscriptionId": "",
"userId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - viewName required
string: The name of the view. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - userId required
string: The user ID. Use * to retrieve hub level view.
- resourceGroupName required
Output
Output schema unknown
Views_Get
Gets a view in the hub.
azure_customer_insights.Views_Get({
"resourceGroupName": "",
"hubName": "",
"viewName": "",
"api-version": "",
"subscriptionId": "",
"userId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - viewName required
string: The name of the view. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - userId required
string: The user ID. Use * to retrieve hub level view.
- resourceGroupName required
Output
- output ViewResourceFormat
Views_CreateOrUpdate
Creates a view or updates an existing view in the hub.
azure_customer_insights.Views_CreateOrUpdate({
"resourceGroupName": "",
"hubName": "",
"viewName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - viewName required
string: The name of the view. - parameters required ViewResourceFormat
- api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ViewResourceFormat
WidgetTypes_ListByHub
Gets all available widget types in the specified hub.
azure_customer_insights.WidgetTypes_ListByHub({
"resourceGroupName": "",
"hubName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output WidgetTypeListResult
WidgetTypes_Get
Gets a widget type in the specified hub.
azure_customer_insights.WidgetTypes_Get({
"resourceGroupName": "",
"hubName": "",
"widgetTypeName": "",
"api-version": "",
"subscriptionId": ""
}, context)Input
- input
object- resourceGroupName required
string: The name of the resource group. - hubName required
string: The name of the hub. - widgetTypeName required
string: The name of the widget type. - api-version required
string: Client Api Version. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output WidgetTypeResourceFormat
Definitions
AssignmentPrincipal
- AssignmentPrincipal
object: The AssignmentPrincipal- principalId required
string: The principal id being assigned to. - principalMetadata
object: Other metadata for the principal. - principalType required
string: The Type of the principal ID.
- principalId required
AuthorizationPolicy
- AuthorizationPolicy
object: The authorization policy.- permissions required
array: The permissions associated with the policy.- items PermissionTypes
- policyName
string: Name of the policy. - primaryKey
string: Primary key associated with the policy. - secondaryKey
string: Secondary key associated with the policy.
- permissions required
AuthorizationPolicyListResult
- AuthorizationPolicyListResult
object: The response of list authorization policy operation.- nextLink
string: Link to the next set of results. - value
array: Results of the list operation.
- nextLink
AuthorizationPolicyResourceFormat
- AuthorizationPolicyResourceFormat
object: The authorization policy resource format.- properties AuthorizationPolicy
- id
string: Resource ID. - name
string: Resource name. - type
string: Resource type.
AzureBlobConnectorProperties
- AzureBlobConnectorProperties
object: The Azure Blob connector properties.- connectionKeyVaultUrl required
string: The connection KeyVault URL.
- connectionKeyVaultUrl required
CanonicalProfileDefinition
- CanonicalProfileDefinition
object: Definition of canonical profile.- canonicalProfileId
integer: Canonical profile ID. - properties
array: Properties of the canonical profile.- items
object: The definition of a canonical profile property.- profileName
string: Profile name. - profilePropertyName
string: Property name of profile. - rank
integer: The rank. - type
string(values: Numeric, Categorical, DerivedCategorical, DerivedNumeric): Type of canonical property value. - value
string: Value of the canonical property.
- profileName
- items
- canonicalProfileId
Connector
- Connector
object: Properties of connector.- connectorId
integer: ID of the connector. - connectorName
string: Name of the connector. - connectorProperties required
object: The connector properties. - connectorType required ConnectorType
- created
string: The created time. - description
string: Description of the connector. - displayName
string: Display name of the connector. - isInternal
boolean: If this is an internal connector. - lastModified
string: The last modified time. - state
string(values: Creating, Created, Ready, Expiring, Deleting, Failed): State of connector. - tenantId
string: The hub name.
- connectorId
ConnectorListResult
- ConnectorListResult
object: The response of list connector operation.- nextLink
string: Link to the next set of results. - value
array: Results of the list operation.- items ConnectorResourceFormat
- nextLink
ConnectorMapping
- ConnectorMapping
object: The connector mapping definition.- connectorMappingName
string: The connector mapping name - connectorName
string: The connector name. - connectorType ConnectorType
- created
string: The created time. - dataFormatId
string: The DataFormat ID. - description
string: The description of the connector mapping. - displayName
string: Display name for the connector mapping. - entityType required
string(values: None, Profile, Interaction, Relationship): Defines which entity type the file should map to. - entityTypeName required
string: The mapping entity name. - lastModified
string: The last modified time. - mappingProperties required ConnectorMappingProperties
- nextRunTime
string: The next run time based on customer's settings. - runId
string: The RunId. - state
string(values: Creating, Created, Failed, Ready, Running, Stopped, Expiring): State of connector mapping. - tenantId
string: The hub name.
- connectorMappingName
ConnectorMappingAvailability
- ConnectorMappingAvailability
object: Connector mapping property availability.- frequency
string(values: Minute, Hour, Day, Week, Month): The frequency to update. - interval required
integer: The interval of the given frequency to use.
- frequency
ConnectorMappingCompleteOperation
- ConnectorMappingCompleteOperation
object: The complete operation.- completionOperationType
string(values: DoNothing, DeleteFile, MoveFile): The type of completion operation. - destinationFolder
string: The destination folder where files will be moved to once the import is done.
- completionOperationType
ConnectorMappingErrorManagement
- ConnectorMappingErrorManagement
object: The error management.- errorLimit
integer: The error limit allowed while importing data. - errorManagementType required
string(values: RejectAndContinue, StopImport, RejectUntilLimit): The type of error management to use for the mapping.
- errorLimit
ConnectorMappingFormat
- ConnectorMappingFormat
object: Connector mapping property format.- acceptLanguage
string: The oData language. - arraySeparator
string: Character separating array elements. - columnDelimiter
string: The character that signifies a break between columns. - formatType required
string(values: TextFormat): The type mapping format. - quoteCharacter
string: Quote character, used to indicate enquoted fields. - quoteEscapeCharacter
string: Escape character for quotes, can be the same as the quoteCharacter.
- acceptLanguage
ConnectorMappingListResult
- ConnectorMappingListResult
object: The response of list connector mapping operation.- nextLink
string: Link to the next set of results. - value
array: Results of the list operation.
- nextLink
ConnectorMappingProperties
- ConnectorMappingProperties
object: The connector mapping properties.- availability required ConnectorMappingAvailability
- completeOperation required ConnectorMappingCompleteOperation
- errorManagement required ConnectorMappingErrorManagement
- fileFilter
string: The file filter for the mapping. - folderPath
string: The folder path for the mapping. - format required ConnectorMappingFormat
- hasHeader
boolean: If the file contains a header or not. - structure required
array: Ingestion mapping information at property level.
ConnectorMappingResourceFormat
- ConnectorMappingResourceFormat
object: The connector mapping resource format.- properties ConnectorMapping
- id
string: Resource ID. - name
string: Resource name. - type
string: Resource type.
ConnectorMappingStructure
- ConnectorMappingStructure
object: Connector mapping property structure.- columnName required
string: The column name of the import file. - customFormatSpecifier
string: Custom format specifier for input parsing. - isEncrypted
boolean: Indicates if the column is encrypted. - propertyName required
string: The property name of the mapping entity.
- columnName required
ConnectorResourceFormat
- ConnectorResourceFormat
object: The connector resource format.- properties Connector
- id
string: Resource ID. - name
string: Resource name. - type
string: Resource type.
ConnectorType
- ConnectorType
string(values: None, CRM, AzureBlob, Salesforce, ExchangeOnline, Outbound): Type of connector.
CrmConnectorEntities
- CrmConnectorEntities
object: The CRM connector entities.- displayName
string: The display name. - isProfile
boolean: Indicating whether this is profile. - logicalName required
string: The logical name.
- displayName
CrmConnectorProperties
- CrmConnectorProperties
object: The CRM connector properties.- accessToken
string: The access token. - connectionString
string: The connection string. - entities required
array: The entities like account, contact, opportunity.- items CrmConnectorEntities
- organizationId required
string: The organization ID. - organizationUrl required
string: The organization URL.
- accessToken
DataSource
- DataSource
object: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules.- dataSourceReferenceId
string: The data source reference id. - dataSourceType
string(values: Connector, LinkInteraction, SystemDefault): The data source type. - id
integer: The data source ID. - name
string: The data source name - status
string(values: None, Active, Deleted): The data source status.
- dataSourceReferenceId
DataSourcePrecedence
- DataSourcePrecedence
object: The data source precedence is a way to know the precedence of each data source.- dataSource DataSource
- precedence
integer: the precedence value.
EnrichingKpi
- EnrichingKpi: The enriching KPI definition.
- aliases
array: The aliases.- items KpiAlias
- calculationWindow required
string(values: Lifetime, Hour, Day, Week, Month): The calculation window. - calculationWindowFieldName
string: Name of calculation window field. - description
object: Localized description for the KPI. - displayName
object: Localized display name for the KPI. - entityType required
string(values: None, Profile, Interaction, Relationship): The mapping entity type. - entityTypeName required
string: The mapping entity name. - expression required
string: The computation expression for the KPI. - extracts
array: The KPI extracts.- items KpiExtract
- filter
string: The filter expression for the KPI. - function required
string(values: Sum, Avg, Min, Max, Last, Count, None, CountDistinct): The computation function for the KPI. - groupBy
array: the group by properties for the KPI.- items
string
- items
- groupByMetadata
array: The KPI GroupByMetadata.- items KpiGroupByMetadata
- kpiName
string: The KPI name. - participantProfilesMetadata
array: The participant profiles. - provisioningState ProvisioningState
- tenantId
string: The hub name. - thresHolds KpiThresholds
- unit
string: The unit of measurement for the KPI.
- aliases
EntityTypeDefinition
- EntityTypeDefinition
object: Describes an entity.- apiEntitySetName
string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. - entityType
string(values: None, Profile, Interaction, Relationship): Type of entity. - fields
array: The properties of the Profile.- items PropertyDefinition
- instancesCount
integer: The instance count. - lastChangedUtc
string: The last changed time for the type definition. - provisioningState ProvisioningState
- schemaItemTypeLink
string: The schema org link. This helps ACI identify and suggest semantic models. - tenantId
string: The hub name. - timestampFieldName
string: The timestamp property name. Represents the time when the interaction or profile update happened. - typeName
string: The name of the entity. - attributes `object
- apiEntitySetName