Obtener estadísticas en Mailjet, con una API

Devuelve los conteos de enviados, entregados, abiertos, clicados, rebotados, spam y bajas de una campaña, lista, remitente o de toda la API key, en total o cada 5 minutos, hora o día. La respuesta trae Data, Count y Total; pagina con Limit y Offset.

Identificador
mailjet_get_statistics

La llamada

POST https://connect.reportei.com/api/tools/mailjet_get_statistics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "CounterSource": "Campaign",
    "CounterTiming": "Message",
    "CounterResolution": "Lifetime"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
CounterSourcestringSíWhat to count. List works only with CounterTiming Message and CounterResolution Lifetime, and Sender only with CounterTiming Message. APIKey covers the whole connected key.Valores: Campaign, List, Sender, APIKey
CounterTimingstringSíMessage counts by the sending time of the emails, Event by the time of each open, click or other event. Event does not work with CounterResolution Lifetime.Valores: Message, Event
CounterResolutionstringSíLifetime gives one total. Day, Hour and Highest, which is 5 minutes, give one row per period and need FromTS.Valores: Lifetime, Day, Hour, Highest
SourceIDstringNoRequired unless CounterSource is APIKey. The CampaignID from List campaign drafts, the list ID from List contact lists or the sender ID from List senders. Several campaign or list IDs go separated by commas.
FromTSstringNoStart of the period, as an RFC3339 date-time or a Unix timestamp. Required unless CounterResolution is Lifetime. The period spans up to 100 periods of the resolution, so up to 100 days with Day.
ToTSstringNoEnd of the period, as an RFC3339 date-time or a Unix timestamp.
LimitintegerNoRows per page, up to 1000. The default is 10.
OffsetintegerNoIndex of the first row of the page. The default is 0.

Conexiones posibles

Tu cliente conecta su cuenta de Mailjet una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Usuario y contraseña

Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/mailjet_get_statistics. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Mailjet

Ver las 15 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.