logAnalyticsEvent (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 2.0
Invoke this method to log analytics for custom events.
Syntax
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);
Parameters
Name | Type | Required | Description |
---|---|---|---|
data | JSON object | Yes | JSON input |
eventName | String | Yes | Name of the event |
correlationId | GUID | No | Used to group all related API calls together for diagnostic telemetry. |
successCallback | Function | No | A function to call when the promise is successfully returned. |
errorCallback | Function | No | A function to call when the request to return the promise fails. |
Here's the structure of the data
parameter JSON. Be sure to include the fields: conversationId
and 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>"
}
]
}
]
}
Return value
Promise with value as string
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);
See also
Feedback
https://aka.ms/ContentUserFeedback.
În curând: Pe parcursul anului 2024, vom elimina treptat Probleme legate de GitHub ca mecanism de feedback pentru conținut și îl vom înlocui cu un nou sistem de feedback. Pentru mai multe informații, consultați:Trimiteți și vizualizați feedback pentru