For more information on using API

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

Getting the Overview report info of a specific Push campaign.

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Push campaign id. Required. Can be found using the endpoint "Get Push campaigns."

string

Required

aid

Automation id. Required. If the campaign is not from automation - insert 0. Alse, 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

ApiPushCampaignOverviewInfo

Name

Description

Type

Additional information

sent

integer
delivered

decimal number
unsubscribes

integer
errors

integer
failedPercentage

decimal number
opened

decimal number
openedPercentage

decimal number
totalclicks

integer
clickers

integer
click_rate

decimal number

Response Formats

application/json, text/json

Sample: 
{
  "sent": 1,
  "delivered": 2.1,
  "unsubscribes": 3,
  "errors": 4,
  "failedPercentage": 5.1,
  "opened": 6.1,
  "openedPercentage": 7.1,
  "totalclicks": 8,
  "clickers": 9,
  "click_rate": 10.1
}

application/xml, text/xml

Sample: 
<ApiPushCampaignOverviewInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.PushCampaignReport">
  <click_rate>10.1</click_rate>
  <clickers>9</clickers>
  <delivered>2.1</delivered>
  <errors>4</errors>
  <failedPercentage>5.1</failedPercentage>
  <opened>6.1</opened>
  <openedPercentage>7.1</openedPercentage>
  <sent>1</sent>
  <totalclicks>8</totalclicks>
  <unsubscribes>3</unsubscribes>
</ApiPushCampaignOverviewInfo>