For more information on using API
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/OverviewReport
Returns a summary report for a specific automation
Request Information
URI Parameters
Name
Description
Type
Additional information
id
Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id int the URL)
integer
Required
Body Parameters
None.
Response Information
Resource Description
Name
Description
Type
Additional information
emails_clicked
Total clicks in the campaign
integer
emails_unique_clicked
Total clicks in the campaign
integer
emails_opened
Total opened in the campaign
integer
emails_sent
Total sent in the campaign
integer
sms_sent
Total sent in the SMS campaign
integer
sms_clicked
Total sent in the SMS campaign
integer
started
Started campaign
integer
ended
Ended campaign
integer
whatsapp_sent
Total sent in the WhatsApp campaign
integer
push_sent
Total sent in the Push campaign
integer
inappmessage_sent
Total sent in the InApp Message campaign
integer
Response Formats
application/json, text/json
Sample:
{
"emails_clicked": 1,
"emails_unique_clicked": 2,
"emails_opened": 3,
"emails_sent": 4,
"sms_sent": 5,
"sms_clicked": 6,
"started": 7,
"ended": 8,
"whatsapp_sent": 9,
"push_sent": 10,
"inappmessage_sent": 11
}
application/xml, text/xml
Sample:
<ApiAutomationReportOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.AutomationReport"> <emails_clicked>1</emails_clicked> <emails_opened>3</emails_opened> <emails_sent>4</emails_sent> <emails_unique_clicked>2</emails_unique_clicked> <ended>8</ended> <inappmessage_sent>11</inappmessage_sent> <push_sent>10</push_sent> <sms_clicked>6</sms_clicked> <sms_sent>5</sms_sent> <started>7</started> <whatsapp_sent>9</whatsapp_sent> </ApiAutomationReportOverview>