API de detalles de seguimiento
Cuando el destinatario abre o hace clic en su correo electrónico, su dirección se añadirá a la lista de aperturas y clics, en la cual se puede buscar la dirección deseada.
Dirección de invocación
| 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/track_details
Consulta
URL
https://email.api.engagelab.cc/v1/track_details
https://email.api.engagelab.cc/v1/track_details
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
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| time_zone | string | * | Zona horaria; ejemplo: +8; valor predeterminado: +8 |
| start_date | string | * | El formato de la fecha de inicio es yyyy-MM-dd |
| end_date | string | * | El formato de la fecha de fin es yyyy-MM-dd |
| string | * | Dirección de correo electrónico de la lista a consultar | |
| track_type | string | no | 1 significa aperturas; 2 significa clics; si no se incluye este parámetro, se consultan ambos |
| api_users | string | no | Obtener estadísticas del API_USER especificado; varios API_USER se separan mediante punto y coma; p. ej., api_users=a;b;c |
| label_ids | string | no | Obtener estadísticas de la etiqueta especificada; varias etiquetas se separan mediante punto y coma; p. ej., label_ids=a;b;c |
| offset | int | no | Posición inicial, [0-], valor predeterminado: 0 |
| limit | int | no | Cantidad, [0-100], valor predeterminado: 100 |
Ejemplo de solicitud:
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| Dirección de correo electrónico | |
| label_id | label_id del correo electrónico |
| track_type | Aperturas o clics |
| url | URL en la que se hizo clic |
| api_user | Nombre de apiUser |
| curr_time | Hora de la apertura o del clic |
| ip | IP de la apertura o del clic |
| country | País de la IP |
| province | Provincia de la IP |
| city | Ciudad de la IP |
| browser | Navegador de la apertura o del clic |
| device | Dispositivo de la apertura o del clic |
Ejemplo de valores devueltos:
{
"result": [
{
"email": "opfwefs@gmail.com",
"track_type": 1,
"api_user": "sendcloud_op**s",
"url": "",
"curr_time": "2021-06-09 09:49:30",
"email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im",
"ip": "47.190.78.5",
"country": "United States",
"province": "Texas",
"city": "Southlake",
"browser": "google",
"device": ""
}
],
"count": 1,
"total": 2
}
{
"result": [
{
"email": "opfwefs@gmail.com",
"track_type": 1,
"api_user": "sendcloud_op**s",
"url": "",
"curr_time": "2021-06-09 09:49:30",
"email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im",
"ip": "47.190.78.5",
"country": "United States",
"province": "Texas",
"city": "Southlake",
"browser": "google",
"device": ""
}
],
"count": 1,
"total": 2
}
Este bloque de código se muestra en una ventana flotante

