Read email campaign reports: overviews, sent, opens, unopened, clicks per link, bounces, spam complaints and unsubscribes, and statistics per domain, browser and device. Most reports look for the campaign among those sent in a date range (by default, the last 3 months). If the campaign wasn't sent in that range, some endpoints return an error and others an empty list: each endpoint below says which.
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 a full report of your campaigns |
GET | /api/ | Get an overview report for a specific campaign |
GET | /api/ | Get a click report for a specific campaign |
GET | /api/ | Get a specific link clickdetails |
GET | /api/ | Get all the contacts that unsubscribed in a specific email |
GET | /api/ | Get all contacts' activity on a specific campaign |
GET | /api/ | Get campaign openers |
GET | /api/ | Get campaign sent emails |
GET | /api/ | Get contacts that didn't open a specific campaign |
GET | /api/ | Get contacts that reported a specific campaign as "spam" |
GET | /api/ | Get campaign's bounces and quantity of bounces per domain |
GET | /api/ | Get a specific campaign's bounces by bounce type |
GET | /api/ | Get a specific campaign's overview reports per domain |
GET | /api/ | Get the browsers, operating systems and platforms a specific campaign was opened on |
Endpoint details
Get a full report of your campaigns
GET https://webapi.mymarketing.co.il/api/campaignreports
Get a full report of your campaigns that include: send date, opens, clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. You can get campaigns filtered by date and limited to a number of campaigns (by default, campaigns sent in the last 3 months)
| Parameter | In | Type | Description |
|---|---|---|---|
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get an overview report for a specific campaign
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}
Get an overview report for a specific campaign. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an error)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id .Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL). Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get a click report for a specific campaign
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/clickdetails
Get a click report for a specific campaign. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an error)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get a specific link clickdetails
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/clickdetails/{linkId}
Get a specific link clickdetails. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an error)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
linkId | path | integer | Link id. Can be found in the UI ("Email" -> "Email Reports" -> "clickers" -> go to clickers on a specific link -> you will see "linkid=" in the url) Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get all the contacts that unsubscribed in a specific email
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/unsubscribed
Get all the contacts that unsubscribed in a specific email. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get all contacts' activity on a specific campaign
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/emailactivity
Get all contacts' activity on a specific campaign. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an error)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get campaign openers
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/opens
Get campaign openers. You can choose to get all the openers from a specific group. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
group_id | query | integer | Group id. Can be found using the endpoint "Get account's groups" or in the UI (go to Contacts->Groups->click on the group's name -> you'll find the id in the URL) |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get campaign sent emails
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/sent
Get campaign sent emails. You can choose to get only the contacts from a specific group. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
group_id | query | integer | Group id. Can be found using the endpoint "Get account's groups" or in the UI (go to Contacts->Groups->click on the group's name -> you'll find the id in the URL) |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get contacts that didn't open a specific campaign
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/unopened
Get contacts that didn't open a specific campaign. You can choose to get all the contacts that didn't open from a specific group. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
group_id | query | integer | Group id. Can be found using the endpoint "Get account's groups" or in the UI (go to Contacts->Groups->click on the group's name -> you'll find the id in the URL) |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get contacts that reported a specific campaign as "spam"
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/complaints
Get contacts that reported a specific campaign as "spam". You can choose to get all the complaints from a specific group. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
group_id | query | integer | Group id. Can be found using the endpoint "Get account's groups" or in the UI (go to Contacts->Groups->click on the group's name -> you'll find the id in the URL) |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get campaign's bounces and quantity of bounces per domain
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/bounces
Get campaign's bounces and quantity of bounces per domain. You can limit the search to specific time (by default, the search is for campaigns sent in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id in the URL) Required. |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
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
Get a specific campaign's bounces by bounce type
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/bounced
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id Required. |
BounceType | query | string | Get bounces by specific type ("soft" - temporary fail. Future campaigns can be sent to those email addresses or "hard" - permanent fail. Future campaigns will not be sent to those email addresses.) |
Full reference, request and response samples
Get a specific campaign's overview reports per domain
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/domains
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> 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
Get the browsers, operating systems and platforms a specific campaign was opened on
GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/browsing
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> 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.