Estadísticas
Dirección de la solicitud
| Centro de datos | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Turquía | https://emailapi-tr.engagelab.com |
Al utilizar la API REST, se debe asegurar de que el centro de datos seleccionado corresponda a la URL base adecuada.
POST/v1/stats_day
Estadísticas de datos de entrega (por día)
Datos de correo electrónico contabilizados por día
URL
https://email.api.engagelab.cc/v1/stats_day
https://email.api.engagelab.cc/v1/stats_day
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | Sí | Basic base64(apiUser:apiKey) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| time_zone | string | no | Zona horaria; ejemplo: +8 |
| start_date | string | * | start_date, con formato yyyy-MM-dd |
| end_date | string | * | end_date, con formato yyyy-MM-dd |
| api_users | string | no | Obtener estadísticas del API_USER especificado; varios API_USER se separan por punto y coma; por ejemplo, api_users=a;b;c |
| label_ids | string | no | Obtener estadísticas de la etiqueta especificada; varias etiquetas se separan por punto y coma; por ejemplo, label_ids=a;b;c |
| domain_names | string | no | Obtener estadísticas del dominio especificado; varios dominios se separan por punto y coma; por ejemplo, domain_names=a;b;c |
| aggregate_by | boolean(1, 0) | no | Valor predeterminado: 0; si aggregate=1, se devolverán datos agregados |
Consejos: El intervalo de tiempo no puede ser superior a 3 meses.
Ejemplo de solicitud:
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| send_date | Fecha de envío |
| api_user | API_USER |
| domain | Dominio |
| label_id | ID de etiqueta |
| label_name | Nombre de etiqueta |
| targets | Total de destinatarios; número de solicitudes |
| sent | Total enviado |
| delivered | Entregas |
| invalid_email | Número de correos electrónicos no válidos |
| soft_bounce | Rebote suave (soft_bounce) |
| report_spam | Número de reportes de spam |
| total_clicks | Total de clics |
| total_opens | Total de aperturas |
| opens | Aperturas únicas |
| clicks | Clics únicos |
| unsubscribe | Número de bajas |
| delivered_percent | Porcentaje de entregas |
| invalid_email_percent | Porcentaje de correos electrónicos no válidos |
| soft_bounce_percent | Porcentaje de rebote suave |
| report_spam_percent | Porcentaje de reportes de spam |
| total_click_percent | Porcentaje de clics |
| total_open_percent | Porcentaje de aperturas |
| open_percent | Porcentaje de aperturas únicas |
| click_percent | Porcentaje de clics únicos |
| unsubscribe_percent | Porcentaje de bajas |
Ejemplo de valores devueltos:
Respuesta satisfactoria
Estado HTTP: 200
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
# aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
# aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
Este bloque de código se muestra en una ventana flotante
Respuesta con error
Estado HTTP: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
Estadísticas de datos de entrega (por hora)
Datos de correo electrónico contabilizados por hora
URL
https://email.api.engagelab.cc/v1/stats_hour
https://email.api.engagelab.cc/v1/stats_hour
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | Sí | Basic base64(apiUser:apiKey) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| time_zone | string | no | Zona horaria; ejemplo: +8 |
| send_date | string | Sí | Fecha de envío, con formato yyyy-MM-dd |
| api_users | string | no | Obtener estadísticas del API_USER especificado; varios API_USER se separan por punto y coma; por ejemplo, api_users=a;b;c |
| label_ids | string | no | Obtener estadísticas de la etiqueta especificada; varias etiquetas se separan por punto y coma; por ejemplo, label_ids=a;b;c |
Ejemplo de solicitud:
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| send_date | Fecha de envío |
| send_hour | Una hora, dentro de [0 – 23] |
| api_user | API_USER |
| label_id | ID de etiqueta |
| targets | Total de destinatarios; número de solicitudes |
| sent | Total enviado |
| delivered | Entregas |
| invalid_email | Número de correos electrónicos no válidos |
| soft_bounce | Rebote suave (soft_bounce) |
| report_spam | Número de reportes de spam |
| total_clicks | Total de clics |
| total_opens | Total de aperturas |
| opens | Aperturas únicas |
| clicks | Clics únicos |
| unsubscribe | Número de bajas |
| delivered_percent | Porcentaje de entregas |
| invalid_email_percent | Porcentaje de correos electrónicos no válidos |
| soft_bounce_percent | Porcentaje de rebote suave |
| report_spam_percent | Porcentaje de reportes de spam |
| total_click_percent | Porcentaje de clics |
| total_open_percent | Porcentaje de aperturas |
| open_percent | Porcentaje de aperturas únicas |
| click_percent | Porcentaje de clics únicos |
| unsubscribe_percent | Porcentaje de bajas |
Ejemplo de valores devueltos:
Respuesta satisfactoria
Estado HTTP: 200
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
Este bloque de código se muestra en una ventana flotante
Respuesta con error
Estado HTTP: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
Estadísticas de correos electrónicos no válidos (por día)
Consultar estadísticas clasificadas de correos electrónicos no válidos
URL
https://email.api.engagelab.cc/v1/stat_invalids
https://email.api.engagelab.cc/v1/stat_invalids
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | Sí | Basic base64(apiUser:apiKey) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| time_zone | string | no | Zona horaria; ejemplo: +8 |
| start_date | string | no | start_date, con formato yyyy-MM-dd |
| end_date | string | no | end_date, con formato yyyy-MM-dd |
| api_users | string | no | Obtener estadísticas del API_USER especificado; varios API_USER se separan por punto y coma; por ejemplo, apiUserList=a;b;c |
| label_ids | string | no | Obtener estadísticas de la etiqueta especificada; varias etiquetas se separan por punto y coma; por ejemplo, labelIdList=a;b;c |
| domain_names | string | no | Obtener estadísticas del dominio especificado; varios dominios se separan por punto y coma; por ejemplo, domain_names=a;b;c |
| aggregate_by | int(1, 0) | no | Valor predeterminado: 0; si aggregate=1, se devolverán datos agregados |
Consejos:
- Cuando
aggregate=1, todos los datos se agregarán. - Cuando se proporcionan label_id_list y label_name_list al mismo tiempo, se prioriza label_id_list para una consulta precisa; cuando solo se proporciona label_name_list, se realiza una consulta difusa con todos los label_names de la lista.
Ejemplo de solicitud:
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| send_date | Fecha de envío, con formato yyyy-MM-dd |
| api_user | API_USER |
| domain | Dominio |
| label_id | ID de etiqueta |
| label_name | Nombre de etiqueta |
| blacklists | Recuento de correos electrónicos en la lista negra de Engagelab |
| unsubscribes | Recuento de correos electrónicos en la lista de bajas |
| server_errors | Servidores de ESP no disponibles |
| format_errors | Direcciones de destinatario no válidas |
| ip_domain_rejecteds | IP o dominios rechazados |
| not_exists | Destinatarios inexistentes |
| spams | Recuento de correos electrónicos spam |
| sender_recipient_rejecteds | Remitentes o destinatarios rechazados |
| others | Otros |
Ejemplo de valores devueltos
Respuesta satisfactoria
Estado HTTP: 200
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
Este bloque de código se muestra en una ventana flotante
Respuesta con error
Estado HTTP: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
