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

MethodEndpointWhat it does
GET/api/campaignreportsGet a full report of your campaigns
GET/api/campaignreports/{id}Get an overview report for a specific campaign
GET/api/campaignreports/{id}/clickdetailsGet a click report for a specific campaign
GET/api/campaignreports/{id}/clickdetails/{linkId}Get a specific link clickdetails
GET/api/campaignreports/{id}/unsubscribedGet all the contacts that unsubscribed in a specific email
GET/api/campaignreports/{id}/emailactivityGet all contacts' activity on a specific campaign
GET/api/campaignreports/{id}/opensGet campaign openers
GET/api/campaignreports/{id}/sentGet campaign sent emails
GET/api/campaignreports/{id}/unopenedGet contacts that didn't open a specific campaign
GET/api/campaignreports/{id}/complaintsGet contacts that reported a specific campaign as "spam"
GET/api/campaignreports/{id}/bouncesGet campaign's bounces and quantity of bounces per domain
GET/api/campaignreports/{id}/bouncedGet a specific campaign's bounces by bounce type
GET/api/campaignreports/{id}/domainsGet a specific campaign's overview reports per domain
GET/api/campaignreports/{id}/browsingGet 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)

ParameterInTypeDescription
from_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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.
linkIdpathintegerLink 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_idqueryintegerGroup 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_idqueryintegerGroup 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_idqueryintegerGroup 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_idqueryintegerGroup 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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)

ParameterInTypeDescription
idpathintegerCampaign 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_datequerydateStart of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd.
to_datequerydateEnd of the date range. Format: yyyy-mm-dd.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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
ParameterInTypeDescription
idpathintegerCampaign id Required.
BounceTypequerystringGet 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
ParameterInTypeDescription
idpathintegerCampaign 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.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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
ParameterInTypeDescription
idpathintegerCampaign 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.
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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.