Follow

Report Click Details By Campaign

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

GET /campaigns/[campaignId]/clickActivity

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

Request Body Parameters

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

Request Body Example

Using Report Click Details:

curl --request GET \ 
--url 'https://mail.mydomain.com/rest/campaigns/123/clickActivity \
--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 Click statistics in a specific Campaign.  The results include Top 10 Browsers, Browser Types, Domains, and Devices, as well as the number of clicks for each individual URL, or Link.

  • top - The Top 10 items (name) and total clicks (count) of each report
    • topBrowsers
    • topBrowserTypes
    • topDevices
    • topDomains
    • topClickLinks
  • mostClick - The Name of the number one item from each report
    • mostClickBrowser
    • mostClickBrowserType
    • mostClickDevice
    • mostClickDomain
    • mostClickLink

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/clickActivity>;
Date: Fri, 17 Jun 2016 12:54:44 GMT
{
	"topBrowsers": 
	{
		"name": "Chrome"
		"count": 4
	}
	"mostClickDomain": "whatcounts.com"
	"mostClickLink": "http://www.google.com"
	"topBrowserTypes": 
	{
		"name": "Browser"
		"count": 4
	}
	"mostClickBrowser": "Chrome"
	"topDomains": 
	{
		"name": "whatcounts.com"
		"count": 4
	}
	"mostClickBrowserType": "Browser"
	"topClickLinks": 
	{
		"name": "http://www.google.com"
		"count": 2
	}
	{
		"name": "http://www.yahoo.com"
		"count": 1
	}
	{
		"name": "http://www.MSN.com"
		"count": 1
	}
	"mostClickedDevice": "Computer"
	"topDevices":
	{
		"name": "Computer"
		"count": 4
	}
}

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
}

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk