Nombre del servicio
GET https://api.envialosimple.email/api/v1/stats/track
Método de autenticación
Authorization: Bearer <clave API>
Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API
Descripción
Devuelve la analítica de eventos: Aperturas, Clics y Quejas. Puede obtenerse un detalle paginado o un generarse un archivo con los valores.
Parámetros
| Nombre | Tipo | Descripción |
| domainID | String | ID de dominio. Requerido. |
| export | Boolean |
true > Genera un archivo con los valores. false > Detalle paginado. |
| lang | String |
Lenguaje en el que se generará el archivo: es > Español en > Inglés * Solo se usa para export = true |
| limit | Integer |
Cantidad de registros por página. Por defecto: 10. Máximo: 100. * Solo se usa para export = false |
| page | String |
Número de página. Por defecto: 1. * Solo se usa para export = false |
| sort | String |
Ordenar por. Valores posibles: id > Fecha reads > Cant. aperturas clicks > Cant. clics complaints > Cant. quejas Por defecto: id |
| direction | String |
Tipo de ordenamiento. Valores posibles: asc à Ascendente desc > Descendente. Por defecto: Ascendente. |
| dateFrom | Date |
Filtro por fecha desde. Formato: AAAA-MM-DD Ejemplo: 2024-02-01 |
| dateTo | Date |
Filtro por fecha hasta. Formato: AAAA-MM-DD Ejemplo: 2024-02-29 |
| groupBy | String |
Agrupar por. Valores posibles: year > Año month > Mes week > Semana day > Día Por defecto: Día. |
Respuesta
| Campo | Descripción |
| _id | Fecha. Puede ser: día, semana, mes o año dependiendo lo que se haya seleccionado en el parámetro groupBy. |
| reads | Aperturas |
| clicks | Clics |
| complaints | Quejas |
Ejemplo de respuesta
{
"page": 1,
"payload": [
{
"_id": "2024-03",
"reads": 50,
"clicks": 45,
"complaints": 0
},
{
"_id": "2023-12",
"reads": 35,
"clicks": 53,
"complaints": 0
},
{
"_id": "2023-11",
"reads": 90,
"clicks": 66,
"complaints": 2
},
{
"_id": "2023-10",
"reads": 48,
"clicks": 36,
"complaints": 1
},
{
"_id": "2023-09",
"reads": 73,
"clicks": 65,
"complaints": 3
},
{
"_id": "2023-08",
"reads": 65,
"clicks": 41,
"complaints": 0
},
{
"_id": "2023-07",
"reads": 72,
"clicks": 70,
"complaints": 0
},
{
"_id": "2023-06",
"reads": 56,
"clicks": 18,
"complaints": 0
},
{
"_id": "2023-05",
"reads": 32,
"clicks": 20,
"complaints": 0
}
],
"total": 9,
"limit": 50
}
Ejemplo de archivo
Fecha;Abiertos;Cliqueados;Quejas
2024-03;50;45;0
2023-12;35;53;0
2023-11;90;66;2
2023-10;48;36;1
2023-09;73;65;3
2023-08;65;41;0
2023-07;72;70;0
2023-06;56;18;0
2023-05;32;20;0