API REST de Estadísticas de Journey | Automatización de marketing API REST Español

Consulta de datos estadísticos, incluyendo "Estadísticas resumidas de Journey", "Estadísticas de envío de mensajes" y "Estadísticas de envío de WebHook".

Estadísticas de Journey

Consulta los datos del journey: entradas, conversiones objetivo, salidas anticipadas, salidas normales y recuentos en curso.

Endpoint

GET /v1/stats/journey

Autenticación

La API REST de EngageLab utiliza Autenticación Básica HTTP. Agregue el encabezado Authorization en la solicitud HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Este bloque de código se muestra en una ventana flotante

El base64_auth_string se genera mediante: base64(api_key:api_secret)

El nombre del encabezado es "Authorization" y el valor es el par "username:password" codificado en base64 (con dos puntos en medio).
En el contexto de la API de MA, username es la APIKey y password es el APISecret. Obtenga la APIKey y el APISecret agregando una fuente de datos de tipo API.

Ejemplo de solicitud

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Campo	Tipo	Requerido	Descripción
journey_id	String	Sí	ID del journey. Múltiples IDs separados por comas, hasta 100.
time_unit	String	Sí	Unidad de tiempo. Valores: HOUR, DAY.
start_time	String	Sí	Hora de inicio en formato `yyyy-MM-dd`.
end_time	String	Sí	Hora de fin en formato `yyyy-MM-dd`. Hora de fin >= Hora de inicio. Rango máximo de 31 días.

Parámetros de respuesta

Campo	Tipo	Descripción
code	Integer	Indica si la llamada a la API fue exitosa. 0 indica éxito o éxito parcial; otros valores indican fallo.
message	String	Descripción del resultado de la llamada a la API. `success` en caso de éxito.
data	Array<Object>	Datos estadísticos devueltos.
journey_id	Long	ID del journey.
time_unit	String	Unidad de tiempo. Valores: HOUR, DAY.
error_code	Int	Indica si las estadísticas del journey se recuperaron correctamente. 0 indica éxito; otros valores indican fallo.
detail	Array<Object>	Detalles por hora/día.
time	String	Fecha de estadísticas en la respuesta, en formato `yyyy-MM-dd` o `yyyy-MM-dd HH`.
entry_count	Long	Número de entradas.
conversion_count	Long	Número de conversiones.
completion_count	Long	Número de salidas normales.
early_exit_count	Long	Número de salidas anticipadas.
in_progress_count	Long	Número en curso, es decir, que aún están en el journey a la fecha de end_time o time.

Todo exitoso

{ "code": 0, "message": "success", "data": [ { "journey_id":123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id":234, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }] }

              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id":123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id":234,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  }]
}

Este bloque de código se muestra en una ventana flotante

Todo fallido

{ "code": 50219, "message": "The number of JourneyIDs exceeds 100." }

              
              {
  "code": 50219,
  "message": "The number of JourneyIDs exceeds 100."
}

Este bloque de código se muestra en una ventana flotante

Éxito parcial

              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id": -1,
      "error_code": 50221
  }]
}

Este bloque de código se muestra en una ventana flotante

Estadísticas de envío de mensajes

Consulta datos de envío, entrega, clics y otros datos de cada componente de mensaje en un journey.

Endpoint

GET /v1/stats/journey/message

Ejemplo de solicitud

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Campo	Tipo	Requerido	Descripción
journey_id	String	Sí	ID del journey. Múltiples IDs separados por comas, hasta 100.
time_unit	String	Sí	Unidad de tiempo. Valores: HOUR, DAY.
start_time	String	Sí	Hora de inicio en formato `yyyy-MM-dd`.
end_time	String	Sí	Hora de fin en formato `yyyy-MM-dd`. Hora de fin >= Hora de inicio. Rango máximo de 31 días.

Parámetros de respuesta

Campo	Tipo	Descripción
code	Integer	Indica si la llamada a la API fue exitosa. 0 indica éxito o éxito parcial; otros valores indican fallo.
message	String	Descripción del resultado de la llamada a la API. `success` en caso de éxito.
data	Array<Object>	Datos estadísticos devueltos.
journey_id	Long	ID del journey.
time_unit	String	Unidad de tiempo. Valores: HOUR, DAY.
error_code	Int	Indica si las estadísticas del journey se recuperaron correctamente. 0 indica éxito; otros valores indican fallo.
detail	Array<Object>	Detalles por hora/día.
time	String	Fecha de estadísticas en la respuesta, en formato `yyyy-MM-dd` o `yyyy-MM-dd HH`.
component_id	Long	ID del componente de mensaje.
component_name	String	Nombre del componente de mensaje, p. ej., `APP_PUSH_1`, `EMAIL_2`.
channel	String	Tipo de canal.
entry_count	Long	Número de entradas.
plan_count	Long	Recuento de objetivos planificados.
send_count	Long	Número de envíos.
delivery_count	Long	Número de entregas.
impression_count	Long	Número de impresiones.
open_count	Long	Número de aperturas.
click_count	Long	Número de clics.
conversion_count	Long	Número de conversiones.
revenue_count	Long	Número de eventos generadores de ingresos.
revenue_amount	Number	Monto total de ingresos.

Todo exitoso

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-28", "entry_count": 320, "plan_count": 312, "send_count": 290, "delivery_count": 270, "impression_count": 198, "open_count": 155, "click_count": 24, "conversion_count": 8, "revenue_count": 7, "revenue_amount": 488.50 }, { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-29", "entry_count": 305, "plan_count": 298, "send_count": 280, "delivery_count": 261, "impression_count": 185, "open_count": 144, "click_count": 19, "conversion_count": 6, "revenue_count": 5, "revenue_amount": 312.00 } ] } ] }

              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-28",
        "entry_count": 320,
        "plan_count": 312,
        "send_count": 290,
        "delivery_count": 270,
        "impression_count": 198,
        "open_count": 155,
        "click_count": 24,
        "conversion_count": 8,
        "revenue_count": 7,
        "revenue_amount": 488.50
      },
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-29",
        "entry_count": 305,
        "plan_count": 298,
        "send_count": 280,
        "delivery_count": 261,
        "impression_count": 185,
        "open_count": 144,
        "click_count": 19,
        "conversion_count": 6,
        "revenue_count": 5,
        "revenue_amount": 312.00
      }
    ]
  }
]
}

Este bloque de código se muestra en una ventana flotante

Estadísticas de envío de WebHook

Consulta los datos de solicitudes y éxitos de cada componente WebHook en un journey.

Endpoint

GET /v1/stats/journey/webhook

Ejemplo de solicitud

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Campo	Tipo	Requerido	Descripción
journey_id	String	Sí	ID del journey. Múltiples IDs separados por comas, hasta 100.
time_unit	String	Sí	Unidad de tiempo. Valores: HOUR, DAY.
start_time	String	Sí	Hora de inicio en formato `yyyy-MM-dd`.
end_time	String	Sí	Hora de fin en formato `yyyy-MM-dd`. Hora de fin >= Hora de inicio. Rango máximo de 31 días.

Parámetros de respuesta

Campo	Tipo	Descripción
code	Integer	Indica si la llamada a la API fue exitosa. 0 indica éxito o éxito parcial; otros valores indican fallo.
message	String	Descripción del resultado de la llamada a la API. `success` en caso de éxito.
data	Array<Object>	Datos estadísticos devueltos.
journey_id	Long	ID del journey.
time_unit	String	Unidad de tiempo. Valores: HOUR, DAY.
error_code	Int	Indica si las estadísticas del journey se recuperaron correctamente. 0 indica éxito; otros valores indican fallo.
detail	Array<Object>	Detalles por hora/día.
time	String	Fecha de estadísticas en la respuesta, en formato `yyyy-MM-dd` o `yyyy-MM-dd HH`.
component_id	Long	ID del componente de mensaje.
component_name	String	Nombre del componente de mensaje, p. ej., `APP_PUSH_1`, `EMAIL_2`.
entry_count	Long	Número de entradas en el componente Webhook.
send_count	Long	Número de solicitudes exitosas.
send_failure_count	Long	Número de solicitudes fallidas.

Todo exitoso

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-28", "entry_count": 520, "send_count": 498, "send_failure_count": 22 }, { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-29", "entry_count": 610, "send_count": 600, "send_failure_count": 10 } ] } ] }

              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-28",
        "entry_count": 520,
        "send_count": 498,
        "send_failure_count": 22
      },
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-29",
        "entry_count": 610,
        "send_count": 600,
        "send_failure_count": 10
      }
    ]
  }
]
}

Este bloque de código se muestra en una ventana flotante

Códigos de error

Códigos de error comunes

Estado HTTP	code	message	Descripción
401	40050	authorization invalid	Fallo de autenticación.
429	55110	Too many requests, please try again later.	Límite de tasa excedido.
400	40001	http参数不合法	Mensaje HTTP o parámetro de ruta/consulta requerido no válido.
400	40002	业务参数不合法	Fallo de validación de formato, enumeración o tipo de parámetro.
400	50034	项目不存在	El proyecto vinculado a la APIKey no existe.
500	-1	服务器内部错误	Error interno del servidor.

Códigos de error de Estadísticas de Journey

Estado HTTP	code	message	Descripción
400	50202	Journey does not exist.	El journey no existe o no pertenece al proyecto actual.
400	50217	Invalid time range.	`start_time > end_time`, o el rango de consulta supera los 31 días.
400	50219	The number of JourneyIDs exceeds 100.	El número de JourneyIDs supera el límite de 100.
400	50220	Invalid time_unit.	Valor de time_unit no válido; solo se admiten HOUR y DAY.
400	50221	Invalid journey_id format.	Formato de JourneyID individual no válido (campo error_code, indica que una consulta de journey específica falló).
```