logAnalyticsEvent (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 2.0

Tuto metodu vyvolejte k protokolování Analytics pro vlastní události.

Syntaxe

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

Parametry

Název	Typ	Povinné	Description
data	Objekt JSON	Ano	Vstup JSON
Název události	String	Ano	Název akce
ID korelace	GUID	Ne	Slouží k seskupení všech souvisejících volání rozhraní API pro diagnostickou telemetrii.
úspěchZpětné volání	Funkce	Ne	Funkce, která se má volat při úspěšném vrácení příslibu.
errorCallback	Funkce	Ne	Funkce, která se má volat, když požadavek na vrácení příslibu selže.

Zde je struktura parametru data JSON. Nezapomeňte zahrnout pole: conversationId a 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>"
				}
			]
		}
	]
}

Návratová hodnota

Promise s hodnotou jako řetězcem

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);

Související informace

Metoda updateConversation
Analýza kanálu