Get Campaign Results

Esta API permite consultar el detalle avanzado de las campañas de salida (Outbound) ejecutadas en la plataforma. A través de una sola solicitud, se obtiene el listado completo de contactos asociados a una campaña, junto con el estado de cada envío, sus fechas de solicitud y respuesta, y —cuando aplica— la reacción registrada por el destinatario. Esto entrega visibilidad completa sobre el ciclo de vida de cada contacto dentro de la campaña, desde el envío inicial hasta la interacción final.

Note

Esta API aplica únicamente a la versión 1 del módulo de campañas.

GET	{{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/9fe42f19-0b8a-43a6-8bb0-604947e85160
Request (Body JSON)	{ "startDate": "2024-05-01 00:00:00", "endDate": "2024-05-30 00:00:00", "size": 10000, "campaingId": "0X1645XX-0EXX-49XX-BXX3-47C6CXXXXXXX" }
Response	{ "isValid": true, "executionTime": 235.6972, "idReport": "9fe42f19-0b8a-43a6-8bb0-604947e85160", "nameVisualization": "Get Campaing Result", "totalDocument": 3, "pageCount": 0, "lastDocument": "MQ==", "requestCharge": 0, "result": [ { "REQUEST_ID": "00000000-f9e0-4175-0000-9b00000000", "CAMPAIGN_ID": "0X1645XX-0EXX-49XX-BXX3-47C6CXXXXXXX", "CAMPAING_NAME": "Campaña de prueba", "VALID_UNTIL": "2099-12-02T00:00:00", "VALID_FOR_HOURS": "10000", "CONTACT_CHANNEL_ID": "4", "CONTACT_CHANNEL_NAME": "Skype", "CONTACT_NAME": "MIGUEL JUAREZ", "CONTACT_ID": "231f4147-38bf-4444-8404-ec93aXXXXX48", "STATUS": "Sent", "REQUEST_DATE": "2024-05-29T11:27:28.79", "LAST_RESULT_DATE": "2024-05-29T11:27:34.507", "DETAIL": "{ 'status' : '200', 'detail' : 'id: 0:12pr_MMPNQt2JYqOCKj_nbbHw_ynXryr0jPBP8cZ-zY6Sg5YJlW-9hShVGpvRewzI'}", "LOAD_DESCRIPTION": "Default", "REACTION_SESSION": null, "EXPECTED_REACTION": "", "REACTION": null, "REACTED_AS_EXPECTED": null, "REACTION_OUTOF_VALIDUNTIL": null, "REACTION_OUTOF_VALIDFORHOURS": null }, { "REQUEST_ID": "12345678-1234-1234-1234-1234567890", "CAMPAIGN_ID": "0X1645XX-0EXX-49XX-BXX3-47C6CXXXXXXX", "CAMPAING_NAME": "Campaña de Navidad", "VALID_UNTIL": "2099-12-02T00:00:00", "VALID_FOR_HOURS": "10000", "CONTACT_CHANNEL_ID": "16", "CONTACT_CHANNEL_NAME": "Telegram", "CONTACT_NAME": "Carlos Perez", "CONTACT_ID": "95000000-905c-41f8-cccc-a8162c5cf89c", "STATUS": "Sent", "REQUEST_DATE": "2024-05-29T11:27:33.8", "LAST_RESULT_DATE": "2024-05-29T11:27:39.14", "DETAIL": "{ 'status' : '200', 'detail' : 'id: 407-405850970-f'}", "LOAD_DESCRIPTION": "Default", "REACTION_SESSION": null, "EXPECTED_REACTION": "", "REACTION": null, "REACTED_AS_EXPECTED": null, "REACTION_OUTOF_VALIDUNTIL": null, "REACTION_OUTOF_VALIDFORHOURS": null }, { "REQUEST_ID": "6FFFFF-8888-4XXX-aXXX-XXXXXXXX1f", "CAMPAIGN_ID": "0X1645XX-0EXX-49XX-BXX3-47C6CXXXXXXX", "CAMPAING_NAME": "Campaña de Navidad", "VALID_UNTIL": "2099-12-02T00:00:00", "VALID_FOR_HOURS": "10000", "CONTACT_CHANNEL_ID": "3", "CONTACT_CHANNEL_NAME": "Teams", "CONTACT_NAME": "Carlos Ignacio Reyes Perez", "CONTACT_ID": "d9630000-3295-42d2-a848-952a41c1702c", "STATUS": "Reacted", "REQUEST_DATE": "2024-05-29T11:27:17.547", "LAST_RESULT_DATE": "2024-05-29T11:29:28.67", "DETAIL": "{ 'status' : '200', 'detail' : '{ 'message': 'The customer has reacted to the campaign message.', 'status': 'reacted' }' }", "LOAD_DESCRIPTION": "Default", "REACTION_SESSION": "7707e8b5-920d-4e86-8557-5bd3242f163a", "EXPECTED_REACTION": "Carlos Ignacio Reyes Perez|***|Quiero|***|no quiero", "REACTION": "holaaaa", "REACTED_AS_EXPECTED": "false", "REACTION_OUTOF_VALIDUNTIL": "false", "REACTION_OUTOF_VALIDFORHOURS": "false" } ], "errors": [] }

cURL

curl --location '{{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/9fe42f19-0b8a-43a6-8bb0-604947e85160' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{var_token}}' \
--data '{
    "startDate" : "{{startDate}}",
    "endDate" : "{{endDate}}",
    "campaingId": "{{campaignId}}",
    "lastDocument": ""
}'

Parámetros de Ruta (Path Parameters)

Parámetro	Descripción
ly_endpoint	Url base, de acuerdo al ambiente: Testing: premium-testing.lynn.cx Production: premium-production.lynn.cx
ly_tenant	Identificador del tenant
ly_reportId	ID del reporte a ejecutar 9fe42f19-0b8a-43a6-8bb0-604947e85160

Parámetros de Entrada

Campo	Tipo	Requerido	Descripción
startDate	string (date-time)	✅	Fecha y hora de inicio en formato yyyy-MM-dd HH:mm:ss
endDate	string (date-time)	✅	Fecha y hora de término en el mismo formato
size	integer	✅	Cantidad máxima de registros a retornar por página
campaingId	string	✅	Identificador de la campaña a consultar
lastDocument	string	Opcional	Número de documentos por página (tamaño de lote)

Parámetros de result de Salida

Campo	Tipo	Descripción
REQUEST_ID	string	Identificador único de la solicitud de campaña
CAMPAIGN_ID	string	Identificador de la campaña
CAMPAING_NAME	string	Nombre descriptivo de la campaña
VALID_UNTIL	string	Fecha y hora límite de validez del registro
VALID_FOR_HOURS	string	Cantidad de horas de validez asignadas al registro
CONTACT_CHANNEL_ID	string	ID numérico del canal de contacto utilizado
CONTACT_CHANNEL_NAME	string	Nombre del canal de contacto (ej. Skype, Telegram, Teams)
CONTACT_NAME	string	Nombre del contacto asociado
CONTACT_ID	string	Identificador único del contacto en el sistema
STATUS	string	Estado actual del registro (ej. Sent, Reacted)
REQUEST_DATE	string	Fecha y hora en que se realizó la solicitud
LAST_RESULT_DATE	string	Fecha y hora del último resultado/actualización del registro
DETAIL	string	Detalle de la respuesta del canal (status y mensaje del proveedor)
LOAD_DESCRIPTION	string	Descripción de la carga/división que generó el registro
REACTION_SESSION	string / null	ID de la sesión de reacción del usuario, si existe
EXPECTED_REACTION	string	Reacción esperada por parte del usuario
REACTION	string / null	Reacción real recibida por parte del usuario
REACTED_AS_EXPECTED	string / null	Indica si la reacción coincidió con la esperada
REACTION_OUTOF_VALIDUNTIL	string / null	Indica si la reacción ocurrió fuera de la fecha de validez límite
REACTION_OUTOF_VALIDFORHOURS	string / null	Indica si la reacción ocurrió fuera del rango de horas de validez