Nombre del servicio
GET https://api.envialosimple.email/api/v1/stats/bounce
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 rebotes: Duros, Blandos y Total. 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 hard > Cant. Rebotes duros soft > Cant. Rebotes blandos total > Total de rebotes 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. |
| hard | Rebotes Duros |
| soft | Rebotes Blandos |
| total | Cantidad total (Rebotes Duros + Rebotes Blandos) |
Ejemplo de respuesta
{
"page": 1,
"payload": [
{
"_id": "2024-03",
"total": 4,
"hard": 1,
"soft": 3
},
{
"_id": "2024-01",
"total": 5,
"hard": 3,
"soft": 2
},
{
"_id": "2024-04",
"total": 1,
"hard": 0,
"soft": 1
}
],
"total": 3,
"limit": 20
}
Ejemplo de archivo
Fecha;Rebote duro;Rebote blando;Total
2024-03;1;3;4
2024-01;3;2;5
2024-04;0;1;1
Comentarios
0 comentarios
El artículo está cerrado para comentarios.