Read push notification campaigns and their reports: summary, overview, sent, delivered, failed and opens. Without dates, the campaign list covers the last 6 months and the reports the last 3 months.

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/pushcampaign/CampaignGet Push campaigns
GET/api/PushcampaignreportGet Push campaigns reports
GET/api/Pushcampaignreport/GetSummaryGetting the Summary report info of Push campaigns by dates
GET/api/Pushcampaignreport/{id}/{aid}Getting the Overview report info of a specific Push campaign
GET/api/Pushcampaignreport/{id}/SentGetting the sent report (contacts the campaign was sent to) of a specific Push campaign
GET/api/Pushcampaignreport/{id}/DeliveredGetting the delivered report of a specific Push campaign
GET/api/Pushcampaignreport/{id}/FailedGetting the failed report of a specific Push campaign
GET/api/Pushcampaignreport/{id}/OpensGetting the opens report (contacts that opened a campaign) of a specific Push campaign

Endpoint details

Get Push campaigns

GET https://webapi.mymarketing.co.il/api/pushcampaign/Campaign

Get Push campaigns. You can get Push campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)

ParameterInTypeDescription
CampaignIdqueryglobally unique identifier
IncludeDeletedqueryboolean
IncludeNotSentqueryboolean
FilterTypequeryMessageFilterType
pageNumberqueryinteger (Range: inclusive between 1 and 2147483647)
pageSizequeryinteger (Range: inclusive between 1 and 100)
fromDatequerydateStart of the date range, by the date the campaign was last updated. Format: yyyy-mm-dd.
toDatequerydateEnd of the date range, by the date the campaign was last updated. Format: yyyy-mm-dd.
searchTermquerystring

Full reference, request and response samples

Get Push campaigns reports

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport

Get Push campaigns reports . You can get Push campaigns reports filtered (you will get the last 20 campaigns in the last 3 months by default)

ParameterInTypeDescription
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (Range: inclusive between 1 and 100)

Full reference, request and response samples

Getting the Summary report info of Push campaigns by dates

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/GetSummary

Getting the Summary report info of Push campaigns by dates. (default is the last 3 months)

ParameterInTypeDescription
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (Range: inclusive between 1 and 100)

Full reference, request and response samples

Getting the Overview report info of a specific Push campaign

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/{aid}
ParameterInTypeDescription
idpathstringPush campaign id. Can be found using the endpoint "Get Push campaigns." Required.
aidpathintegerAutomation id. If the campaign is not from automation - insert 0. Also, 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

Getting the sent report (contacts the campaign was sent to) of a specific Push campaign

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/Sent

Getting the sent report (contacts the campaign was sent to) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" and "to date". (default is the last 3 months)

ParameterInTypeDescription
idpathstringPush campaign id. Can be found using the endpoint "Get Push campaigns." Required.
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (Range: inclusive between 1 and 100)

Full reference, request and response samples

Getting the delivered report of a specific Push campaign

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/Delivered

Getting the delivered report (contacts the campaign was delivered to) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" and "to date". (default is the last 3 months)

ParameterInTypeDescription
idpathstringPush campaign id. Can be found using the endpoint "Get Push campaigns." Required.
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (Range: inclusive between 1 and 100)

Full reference, request and response samples

Getting the failed report of a specific Push campaign

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/Failed

Getting the failed report (contacts the campaign was sent to but got a delivery failure) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" and "to date". (default is the last 3 months)

ParameterInTypeDescription
idpathstringPush campaign id. Can be found using the endpoint "Get Push campaigns." Required.
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (Range: inclusive between 1 and 100)

Full reference, request and response samples

Getting the opens report (contacts that opened a campaign) of a specific Push campaign

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/Opens

Getting the opens report (contacts that opened a campaign) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" and "to date". (default is the last 3 months)

ParameterInTypeDescription
idpathstringPush campaign id. Can be found using the endpoint "Get Push campaigns." Required.
send_typequeryinteger
search_termquerystring
from_datequerydateStart of the date range: the campaign must have been sent in this range.
to_datequerydateEnd of the date range.
pagequeryinteger (Range: inclusive between 1 and 2147483647)
limitqueryinteger (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.