logAnalyticsEvent (JavaScript API-referens) för Dynamics 365 Channel Integration Framework 2.0

Anropa den här metoden för att logga analys för anpassade händelser.

Syntax

Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);

Parameterar

Namn	Typ	Krävs	Description
data	JSON-objekt	Yes	JSON-indata
händelsenamn	String	Yes	Namnet på händelsen
correlationId	GUID (globalt unikt identifierare)	Nej	Används för att gruppera alla relaterade API-anrop för diagnostisk telemetri.
framgångCallback	Funktion	Nej	En funktion som ska anropas när löftet returneras.
errorCallback	Funktion	Nej	En funktion som ska anropas när begäran om att returnera löftet misslyckas.

Här är strukturen data för parametern JSON. Se till att ta med fälten: conversationId och providerSessionId.

{
	"conversationId": "<Conversation identifier>",
	"providerSessionId": "<Channel Integration Framework Provider Id>",
	"clientSessionId":"<Client session identifier>",
	"participantId":"<Participant identifier>",
	"events": [
		{
			"kpiEventName": "<Name of the associated KPI event>",
			"kpiEventReason": "<Reason due to which the KPI event was created>",
			"eventTimestamp": "<Timestamp at which the event occurred>",
			"additionalData": "<Additional data related to the session>",
			"notificationResponseAction":"<Agent notification response action value>",
			"externalCorrelationId": "<External system correlation Id>",
			"customData": [
				{
					"attribute": "<name>",
					"value": "<value>"
				}
			]
		}
	]
}

Returvärde

Löfte med värde som sträng

Example

//Success callback handler
const successCallback = (result) => {
  // result will indicate if the custom analytics event has been logged
  console.log(result);
};

//Failure callback handler
const errorCallback = (error) => {
  // handling failure
  console.error(error)
};

Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);

Relaterad information

updateConversation-metoden
Analys av kanaler