For more information on using API

GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/bounces?FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Get campaign's bounces and quantity of bounces per domain. You can limit the search to specific time (by default, the search will be for campaigns that were updated 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)

Request Information

URI Parameters

Name

Description

Type

Additional information

id

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 int the URL)

integer

Required

from_date

The start date the campaign was last updated

date
to_date

The end date the campaign was last updated

date
page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiCampaignBouncesList

Name

Description

Type

Additional information

total_bounces

Bounces = Emails that could not be delivered due to an error.

integer
total_bounce_rate

Bounce Rate = Bounces / Sent.

decimal number
selected_bounces

List of campaign bounces

Collection of ApiCampaignBounces
selected_bounces_domain

List of campaign domains bounces

Collection of BouncesByDomain

Response Formats

application/json, text/json

Sample: 
{
  "total_bounces": 1,
  "total_bounce_rate": 2.1,
  "selected_bounces_domain": [
    {
      "domain_name": "sample string 1",
      "bounces": 2
    },
    {
      "domain_name": "sample string 1",
      "bounces": 2
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiCampaignBouncesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <selected_bounces i:nil="true" />
  <selected_bounces_domain>
    <BouncesByDomain>
      <bounces>2</bounces>
      <domain_name>sample string 1</domain_name>
    </BouncesByDomain>
    <BouncesByDomain>
      <bounces>2</bounces>
      <domain_name>sample string 1</domain_name>
    </BouncesByDomain>
  </selected_bounces_domain>
  <total_bounce_rate>2.1</total_bounce_rate>
  <total_bounces>1</total_bounces>
</ApiCampaignBouncesList>