Obter relatório no Omnisend, por uma API
Retorna métricas agregadas de campanhas e automações, agrupadas pela data de envio das mensagens: envios, aberturas, cliques, bounces, spam, cancelamentos de inscrição e pedidos e receita atribuídos, como totais ou detalhados por dimensões. Limitado a 10 chamadas por minuto e 55 por dia para a marca.
- Identificador
- omnisend_get_report
A chamada
POST https://connect.reportei.com/api/tools/omnisend_get_report/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"queries": []
}
}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 |
|---|---|---|---|
| queries | array | Sim | From 1 to 4 queries. The response has one report per alias, each with rows that carry a key per dimension and per metric. |
Conexões possíveis
O seu cliente conecta a conta do Omnisend uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave 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/omnisend_get_report. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Omnisend
- Listar contatosGETLista os contatos com id, email, phone, status, tags, segments e propriedades customizadas, do mais novo para o mais antigo por padrão. A resposta tem contacts e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Criar contatoPOSTCria um contato, ou atualiza o contato que já tem o mesmo identificador de email. Definir um canal como subscribed envia a mensagem de boas-vindas da marca, quando essa automação está ativa, a menos que sendWelcomeMessage seja false.
- Atualizar contatoPATCHAtualiza um contato. Só os campos enviados mudam, mas tags substitui a lista inteira de tags: para só adicionar tags, use Aplicar tags. Um status de canal em identifiers inscreve ou cancela a inscrição do contato.
- Aplicar tagsPOSTAdiciona tags a contatos, mantendo as tags que eles já têm. Escolha os contatos por contactIDs, emails, phones ou segmentID; as seleções se somam. Limitado a 60 chamadas por minuto.
- Listar segmentosGETLista os segmentos com segmentID, name e status. O segmentID direciona campanhas e filtra contatos. A resposta tem segments e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar templates de emailGETLista os templates de email com id e name, do mais novo para o mais antigo por padrão. O id é o corpo de uma campanha de email. A resposta tem templates e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar campanhasGETLista as campanhas com id, name, status, channel, content, audience e configurações de envio, da mais nova para a mais antiga por padrão. A resposta tem campaigns e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Criar campanhaPOSTCria uma campanha comum de email ou SMS como rascunho e a retorna com seu id. Uma campanha de email precisa de content.email.templateID, de Listar templates de email, e uma de SMS precisa de content.sms. Nada é enviado até Enviar campanha.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
