For more information on using API

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

Get a Campaign Bounces

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id

integer

Required

from_date

The first date the contacts you want were created

date
to_date

The last date the contacts you want were created.(Default values is 3 last months)

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.

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>