Read automation reports: overview and summary reports, statistics for email, SMS, WhatsApp and push steps, and the contacts that started, finished or are still in an automation.
All endpoints use the base URL https://webapi.mymarketing.co.il and an API key in the Authorization header. New to the API? Start with Get started with the ActiveTrail API.
Endpoints
| Method | Endpoint | What it does |
|---|---|---|
GET | /api/ | Get the contacts that started an automation, with their steps |
GET | /api/ | Returns all the contacts that did not finish a specific automation |
GET | /api/ | Get email campaigns statistics for a specific automation |
GET | /api/ | Get SMS campaigns statistics for a specific automation |
GET | /api/ | Get Whatsapp campaigns statistics for a specific automation |
GET | /api/ | Get Push Notification campaigns statistics for a specific automation |
GET | /api/ | Get the overview report of a specific automation |
GET | /api/ | Get the summary report of each email step in a specific automation |
GET | /api/ | Get the summary report of the SMS steps in a specific automation |
GET | /api/ | Returns the contacts that started a specific automation |
GET | /api/ | Returns the contacts that finished a specific automation |
Endpoint details
Get the contacts that started an automation, with their steps
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/logautomation
Returns all the contacts that started a specific automation and shows all their steps in the automation.
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Returns all the contacts that did not finish a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/logautomationqueue
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get email campaigns statistics for a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationemailscampaignstatistic
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
includePreviewContent | query | boolean | Whether or not to include the content of the email in the report. (Default value is True) |
Full reference, request and response samples
Get SMS campaigns statistics for a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationsmscampaignstatistic
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get Whatsapp campaigns statistics for a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationwhatsappcampaignstatistic
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get Push Notification campaigns statistics for a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationpushnotificationcampaignstatistic
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get the overview report of a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/OverviewReport
Get the overview report of a specific automation: how many contacts started and finished it, and how many emails, SMS, WhatsApp and push messages it sent, with email opens and clicks and SMS clicks.
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get the summary report of each email step in a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/SummaryReport
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Get the summary report of the SMS steps in a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/SMSCampaignSummaryReport
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
Full reference, request and response samples
Returns the contacts that started a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/ContactsStarted
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Returns the contacts that finished a specific automation
GET https://webapi.mymarketing.co.il/api/automationreports/{id}/ContactsEnded
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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 in the URL) Required. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
This reference is based on the ActiveTrail API documentation, where you can also test each endpoint with your own API key.