Os dados obtidos dessa maneira, são os mesmos que usamos para preencher o painel de Atividade.
Endpoints:
- /api/search/ - Para informações da atividade dos emails;
- /api/search/<uuid>/ - Para informações da atividade de um email específico;
- Para esse segundo endpoint é apenas necessário incluir o uuid do email na url, nenhum outro parâmetro é necessário.
Parâmetros para o primeiro endpoint:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| app_id | Número | Sim | As informações de emails são dadas por app. Portanto é necessário fornecer o app_id, |
| start | Texto | Sim | Data que inicial para a pesquisa. Formato esperado: 'YYYY-MM-DD', exemplo: '2017-09-12' |
| end | Texto | Sim | Data final para a pesquisa. Formato esperado: 'YYYY-MM-DD', exemplo: '2017-09-19' |
| template_slug | Texto | Não | É possível filtrar os emails pelo slug do template. |
| status | Lista de Números | Não | Os estados que um email pode assumir, variando de não entregue, bloqueado, entregue, etc. |
| name_sender | Texto | Não | Nome do remetente. É possível enviar o primeiro trecho do nome. |
| email_sender | Texto | Não | Email do remetente. É necessário enviar um email válido. |
| name_receiver | Texto | Não | Nome do destinatário. É possível enviar o primeiro trecho do nome. Obs: Esse é o mesmo nome que o fornecido no momento do envio. Ou seja, aquele presente |
| email_receiver | Texto | Não | Email do destinatário. É necessário enviar um email válido. |
A requisição segue o mesmo procedimento feito para enviar um email.
Obs: É possível realizar estas mesmas pesquisas usando o client. Eis para uma pesquisa com filtros veja esses exemplos, e para uma pesquisa usando uuids veja estes.