API: Rest Report Bounce Details By Campaign

The Report Bounce Details command allows you to get the details seen in the Campaign Details page for Hard, Soft and Block Bounce events.  This includes top 10 domains per bounce type and the number of bounces per Category.

GET /campaigns/[campaignId]/bounceActivity

https://[siteurl]/rest/campaigns/[campaignId]/bounceActivity

Request Body Parameters

The Report Bounce Details command requires only the URI call. No additional fields are required in the JSON. 

Request Body Example

Using Report Bounce Details:

curl --request GET \
--url 'https://mail.mydomain.com/rest/campaigns/123/bounceActivity \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--header 'content-type: application/json' \
--include

Response Body

The response returns report data in JSON format for Bounce statistics in a specific Campaign.  The results include Top 10 Domains and number of bounces per Category (bouncesDetail). 

• BouncesDetail - The Top 10 Categories (name) and total number of Bounces per Category (count)

  • allBouncesDetail

  • hardBouncesDetail

  • softBouncesDetail

  • blockBouncesDetail

• Bounces - The Top 10 Domains (name) and total number of Bounces per Bounce Type (count)

  • TotalBounces

  • HardBounces

  • SoftBounces

  • BlockBounces

Based on the example above the response returns:

HTTP/1.1 200 OK Server: serverName Content-Type: application/json Link: <https://mail.mydomain.com/rest/campaigns/123/bounceActivity>; Date: Fri, 17 Jun 2016 12:54:44 GMT { "hardBouncesDetail": "allBouncesDetail": { "name": "Access Denied" "count": 2 } { "name": "Content Error" "count": 1 } "SoftBounces": { "name": "whatcounts.com" "count": 1 } "BlockBounces": { "name": "whatcounts.com" "count": 2 } "TotalBounces": { "name": "whatcounts.com" "count": 3 } "HardBounces": "blockedBouncesDetail": { "name": "Access Denied" "count": 2 } "softBouncesDetail": { "name": "Content Error" "count": 1 } }

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes. 

For example, if the Authorization is incorrect, the error would appear as:

{ "error": "Unauthorized" "status": "Unauthorized" "statusCode": 401 }