Analítica de envíos

Supervisor
Supervisor
  • Actualización

Nombre del servicio

GET https://api.envialosimple.email/api/v1/stats/mail

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 envíos: Procesados, Entregados y Rechazados. 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

processed > Cant. pocesados

delivered > Cant. entregados

rejected > Cant. rechazados

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.
processed Emails procesados
delivered Emails entregados
rejected Emails rechazados

Ejemplo de respuesta

{

    "page": 1,

    "payload": [

        {

            "_id": "2024-02-29",

            "processed": 500,

            "delivered": 490,

            "rejected": 10

        },

        {

            "_id": "2024-02-16",

            "processed": 382,

            "delivered": 380,

            "rejected": 2

        },

        {

            "_id": "2024-02-15",

            "processed": 430,

            "delivered": 430,

            "rejected": 0

        }

    ],

    "total": 3,

    "limit": 10

}

Ejemplo de archivo

Fecha;Procesados;Entregados;Rechazados

2024-02-29;500;490;10

2024-02-16;382;380;2

2024-02-15;430;430;0

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

El artículo está cerrado para comentarios.