API: Rest Report Open Details by Campaign

The Report Open Details command allows you to get the details seen in the Campaign Details page for Open, or Read, events.  This includes top 10 domains, browser, and device information.

NOTE: In some realms, tracking browser information may not be permitted in order to honor privacy requirements in certain areas.  Please contact your Account Manager if you have questions.

GET /campaigns/[campaignId]/openActivity

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

Request Body Parameters

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

Request Body Example

Using Report Open Details:

curl --request GET \
--url 'https://mail.mydomain.com/rest/campaigns/123/openActivity \
--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 Open statistics in a specific Campaign.  The results include Top 10 Browsers, Browser Types, Domains, and Devices.

• top - The Top 10 items (name) and total opens (count) of each report

  • topBrowsers

  • topBrowserTypes

  • topDevices

  • topDomains

• mostOpen - The Name of the number one item from each report

  • mostOpenBrowser

  • mostOpenBrowserType

  • mostOpenDevice

  • mostOpenDomain

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/openActivity>; Date: Fri, 17 Jun 2016 12:54:44 GMT { "topBrowsers": { "name": "Firefox 11" "count": 9 } "topBrowserTypes": { "name": "Browser" "count": 9 } "mostOpenBrowserType": "Browser" "topDomains": { "name": "whatcounts.com" "count": 9 } "mostOpenDomain": "whatcounts.com" "mostOpenBrowser": "Firefox 11" "mostOpenDevice": "Computer" "topDevices": { "name": "Computer" "count": 9 } }

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 }