API de Monitoreo Lynn

Ofrece acceso a la explotación de data para conocer por ejemplo el estado general de Lynn y su conector, estado de salud de todas las solicitudes entrantes desde diversos canales al conector de Lynn y estado de salud de todas las solicitudes salientes desde Lynn a los diversos canales configurados para el aplicativo.

Generación de token de autenticación API de Monitoreo Lynn

Uno de los requisitos necesarios para el uso de la API de Monitoreo Lynn es verificar que el consumidor (usuario o servicio) tenga autorización para el uso del API; Para ello lo primero que debe hacer es obtener el token de autenticación.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta:

/api/LynnReporting/CreateToken

Ejemplo Postman:

Método: POST

Tabla de parámetros:

Parámetro	Locación	Descripción
	BODY	{ "accessToken": "string", "accessTokenSecret": "string", "tenant": “number” } accessToken Cadena de texto que forma parte de los parámetros de autenticación, se genera al momento de crear las credenciales de seguridad del tenant y ya no se puede modificar. Ejemplo: 902eeeeee9752f1. Nota: Es similar a un usuario. accessTokenSecret Cadena de texto que forma parte de los parámetros de autenticación, se genera al momento de crear las credenciales de seguridad del tenant y ya no se puede modificar. Ejemplo: 66aaaaa1b-4da4-4005-9883-44b8000006d5. Tenant Identificador numérico del tenant. Se obtiene en la interfaz gráfica de Lynn.

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	Nota: Esta respuesta se debe incluir en la cabecera de las peticiones siguientes para poder manejar la seguridad. Ejemplo: Variable Authorization: bearer eyJhbGciOiJIUzoEzKw4ly8jgmmAoxJbg Json Respuesta { "token": "eIkpXVCJ9.eyJhefWYXY8888884YxLxrCWKVeY4N Us_2c239NG4" }
401	Unauthorized	Sin Respuesta.

Ejecutar reporte Status Tenant

Muestra el estado general del Lynn y su conector.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta:

/api/LynnReporting/Status/{{tenant}}

Ejemplo Postman:

Método: POST

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	InternalReponseTime (int - miliseconds) Tiempo promedio de respuesta de Lynn. Status (string) up: Los servidores de Lynn estan trabajando normalmente. down: Los servidores de Lynn no estan disponible. TrafficInformation (string): Información del tráfico para el tenant consultado. Sessions (int): Número de sesiones agrupadas por división, canal y servicio. Division (int): División de Lynn donde se han generado las sesiones. Channel (int): Identificador del canal. Service (int): Identificador del servicio. ConnectorStatus: up: El conector de Lynn hacia los canales está trabajando normalmente. down: El conector de Lynn no está disponible.
401	Unauthorized	Sin Respuesta.

Ejecutar reporte Inbound Health Detail

Muestra el estado de salud de todas las solicitudes entrantes desde diversos canales al conector de Lynn.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta:

/api/LynnReporting/ExecuteReport/{{tenant}}/29CDB989-6221-4742-96CA-1A878545B5A3

Ejemplo Postman:

Método: POST

Tabla de parámetros

Parámetro	Locación	Descripción
	BODY	{ "startDate" : "2023-08-10 16:51:14", "endDate" : "2023-08-14 18:00:35", "size" : 10000, "lastDocument": " " } startDate (Requerido):Fecha de inicio de la consulta. endDate (Requerido): Fecha de fin de la consulta. size: Número de registros solicitados. lastDocument: Id para consultar la siguiente página.

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	isValid (boolean) Validación del Request, True si el body es válido. executionTime (ms) Tiempo que demoró en realizar la consulta. idReport(string) Guid del reporte consultado. nameVisualization (string) Nombre del reporte. totalDocument (int) Total de documentos encontrados.
		pageCount (Deshabilitado para este reporte). lastDocument (string) Id identificador para consultar la siguiente página. Id (string) Guid que identifica la sesión de Lynn. Date (date - string) Fecha del registro de salud. Channel (int) Identificador del canal de comunicación. Service (int) Numero de servicio de Lynn. Client (string) Nombre del usuario que ha generado la sesión. ReponseTime (double - miliseconds) Tiempo que ha demorado el conector de Lynn en procesar el mensaje. ReponseCode (int) Código de respuesta para el mensaje procesado por el conector de Lynn. Error (string) Error al procesar el mensaje. BotLatency (int - miliseconds) Tiempo que ha demorado el mensaje en llegar al conector de Lynn. Payload (string) Mensaje recibido por el conector de Lynn y enviando por el canal de comunicación. Origin (string) Origen desde donde el mensaje fue enviado.
401	Unauthorized	Sin Respuesta.

Ejecutar reporte Inbound Health Summary

Exhibe un resumen detallado acerca del estado de las solicitudes entrantes al conector de Lynn desde diversos canales. Estas solicitudes estarán organizadas en grupos según el canal de ingreso, el tipo de servicio solicitado, su origen y el código de respuesta obtenido.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta:

/api/LynnReporting/ExecuteReport/{{tenant}}/7B9D4B85-0176-428B-BFED-9618940D473A

Ejemplo Postman:

Método: POST

Tabla de parámetros

Parámetro	Locación	Descripción
	BODY	{ "startDate" : "2023-08-10 16:51:14", "endDate" : "2023-08-14 18:00:35", "size" : 10000, "lastDocument": "" } startDate (Requerido) Fecha de inicio de la consulta. endDate (Requerido) Fecha de fin de la consulta. size Número de registros solicitados. lastDocument** Id para consultar la siguiente página.

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	isValid (boolean) Validación del Request, True si el body es válido. executionTime (ms) Tiempo que demoró en realizar la consulta. idReport(string) Guid del reporte consultado. nameVisualization (string) Nombre del reporte. totalDocument (int) Total de documentos encontrados.
		pageCount (Deshabilitado para este reporte). lastDocument (string) Id identificador para consultar la siguiente página. Id (string) Guid que identifica la sesión de Lynn. ReponseCode (int) Código de respuesta para el mensaje procesado por el conector de Lynn. Channel (int) Identificador del canal de comunicación. Service (int) Numero de servicio de Lynn. Origin (string) Origen desde donde el mensaje fue enviado. Count (string) Total de solicitudes con el ResponseCode indicado. AvegareReponseTime (double - miliseconds) Tiempo promedio del total de solicitudes, que ha demorado el conector de Lynn en procesar el mensaje para el total de mensajes. AvegareBotLatency (int - miliseconds) Tiempo promedio del total de solicitudes, que ha demorado el mensaje en llegar al conector de Lynn.
401	Unauthorized	Sin Respuesta.

Ejecutar reporte Outbound Health Detail

Muestra el estado de salud de todas las solicitudes salientes desde Lynn a los diversos canales configurados para el aplicativo.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta: /api/LynnReporting/ExecuteReport/{{tenant}}/69FD4E08-7BD1-45B3-9370-1EF0DC774EB5

Ejemplo Postman:

Método: POST

Tabla de parámetros

Parámetro	Locación	Descripción
	BODY	{ "startDate": "2023-08-10 16:51:14", "endDate" : "2023-08-14 18:00:35", "size" : 10000, "lastDocument": " " } startDate (Requerido):Fecha de inicio de la consulta. endDate (Requerido) Fecha de fin de la consulta. size Número de registros solicitados. lastDocument Id para consultar la siguiente página.

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	isValid (boolean) Validación del Request, True si el body es válido. executionTime (ms) Tiempo que demoró en realizar la consulta. idReport(string) Guid del reporte consultado. nameVisualization (string)*Nombre del reporte. totalDocument (int)** Total de documentos encontrados.
		pageCount (Deshabilitado para este reporte). lastDocument (string) Id identificador para consultar la siguiente página. Id (string) Guid que identifica la sesión de Lynn. Date (date - string) Fecha del registro de salud. Channel (int) Identificador del canal de comunicación. Service (int) Numero de servicio de Lynn. Client (string) Nombre del usuario que ha generado la sesión. ReponseTime (double - miliseconds) Tiempo que ha demorado el servicio en procesar el request. ReponseCode (int) Código de respuesta recibido por el servicio consultado. Error (string) Error al procesar el mensaje. ActionId (string) Número de la acción de Lynn que ha ejecutado el request. Es -1 si el request ha sido ejecutada por un canal. Payload (string) Payload enviado por Lynn. Reponse (string) Repuesta desde del servicio consultado. Origin (string) Origen desde donde el mensaje fue enviado.
401	Unauthorized	Sin Respuesta.

Ejecutar reporte Outbound Health Summary

Exhibe un resumen detallado acerca del estado de las solicitudes salientes desde Lynn hacia los canales. Estas solicitudes estarán organizadas en grupos según el canal, el identificador de servicio y el código de respuesta obtenido.

Puntos Importantes:

• Método Protegido: No, se puede consultar directamente.

Ruta:

/api/LynnReporting/ExecuteReport/{{tenant}}/7B9D4B85-0176-428B-BFED-9618940D473A

Ejemplo Postman:

Método: POST

Tabla de parámetros

Parámetro	Locación	Descripción
	BODY	{ "startDate" : "2023-08-10 16:51:14", "endDate" : "2023-08-14 18:00:35", "size" : 10000, "lastDocument": " " } startDate (Requerido) Fecha de inicio de la consulta. endDate (Requerido) Fecha de fin de la consulta. size Número de registros solicitados. lastDocument Id para consultar la siguiente página.

Respuestas

Código http	Descripción	Cuerpo de la respuesta
200	Success	isValid (boolean) Validación del Request, True si el body es válido. executionTime (ms) Tiempo que demoró en realizar la consulta. idReport(string) Guid del reporte consultado. nameVisualization (string) Nombre del reporte. totalDocument (int) Total de documentos encontrados.
		pageCount (Deshabilitado para este reporte). lastDocument (string) Id identificador para consultar la siguiente página. Id (string) Guid que identifica la sesión de Lynn. ReponseCode (int) Código de respuesta para el mensaje procesado por el conector de Lynn. Channel (int) Identificador del canal de comunicación. Service (int) Numero de servicio de Lynn. Count (string) Total de solicitudes con el ResponseCode indicado. AvegareReponseTime (double - miliseconds) Tiempo promedio del total de solicitudes, que ha demorado el conector de Lynn en procesar el mensaje para el total de mensajes.
401	Unauthorized	Sin Respuesta.