Evento logAnalyticsEvent (referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 2.0
Invoque este método para registrar análisis para eventos personalizados.
Sintaxis
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);
Parámetros
Name | Type | Obligatorio | Descripción |
---|---|---|---|
datos | Objeto JSON | Sí | Entrada de JSON |
eventName | String | Sí | Nombre del evento |
correlationId | GUID | No | Se usa para agrupar todas las llamadas API relacionadas para telemetría de diagnóstico. |
successCallback | Function | No | Una función para llamar cuando Promise se devuelve correctamente. |
errorCallback | Function | No | Una función para llamar cuando la solicitud de devolución de Promise falla. |
Esta es la estructura del parámetro JSON data
. Asegúrese de incluir los campos: conversationId
y 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>"
}
]
}
]
}
Valor de retorno
Promise con el valor como cadena
Ejemplo
//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);