Obter estatísticas no Mailjet, por uma API
Retorna as contagens de enviados, entregues, abertos, clicados, rejeitados, spam e cancelamentos de uma campanha, lista, remetente ou de toda a API key, no total ou a cada 5 minutos, hora ou dia. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Identificador
- mailjet_get_statistics
A chamada
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"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CounterSource | string | Sim | 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 |
| CounterTiming | string | Sim | 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 |
| CounterResolution | string | Sim | 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 |
| SourceID | string | Não | Required 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. |
| FromTS | string | Não | Start 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. |
| ToTS | string | Não | End of the period, as an RFC3339 date-time or a Unix timestamp. |
| Limit | integer | Não | Rows per page, up to 1000. The default is 10. |
| Offset | integer | Não | Index of the first row of the page. The default is 0. |
Conexões possíveis
O seu cliente conecta a conta do Mailjet uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/mailjet_get_statistics. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Mailjet
- Listar contatosGETLista os contatos da conta com email, nome, status de exclusão e datas de atividade, opcionalmente só os de uma lista. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Obter contatoGETRetorna um contato, encontrado pelo ID ou pelo endereço de email, com nome, status de exclusão e datas de atividade. Use para obter o ID de um contato que você só conhece pelo email.
- Atualizar contatoPUTAltera o nome de um contato ou sua exclusão de emails de marketing. Só os campos enviados mudam. Um contato excluído continua recebendo emails transacionais.
- Listar listas de contatosGETLista as listas de contatos com ID, nome, número de inscritos e status de exclusão. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Criar lista de contatosPOSTCria uma lista de contatos vazia e a retorna com seu ID.
- Gerenciar contato da listaPOSTAdiciona um contato a uma lista por email, criando o contato quando o email é novo e definindo seu nome e propriedades, ou cancela a inscrição ou o remove da lista, conforme Action.
- Listar propriedades de contatoGETLista as propriedades de contato da conta com nome, tipo de dado e namespace. Os nomes são as chaves de Properties em Manage list contact. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Listar remetentesGETLista os endereços e domínios remetentes da conta com ID, email, nome e status. Só um remetente Active pode enviar uma campanha. A resposta traz Data, Count e Total; pagine com Limit e Offset.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
