Get campaign link activity
Request
Parameter |
In |
Type |
Required |
Description |
---|---|---|---|---|
|
path |
string |
true |
The ID of the campaign that you want to get link activity by location of. |
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
query |
string |
true |
The API key of your account. |
GET https://{hostname}/v3/campaigns/{CampaignID}/stats/links.{Format}?apikey=
Response
Status |
Description |
Headers |
Schema |
---|---|---|---|
|
The request is successful. |
|
N/A |
{
"Code": 0,
"Error": null,
"Context": {
"Paging": {
"PageSize": 0,
"CurrentPage": 1,
"TotalResults": 0,
"TotalPageCount": 0,
"SortExpression": null,
"SortIsAscending": false
},
"Analytics": [
{
"Context": "http://someUrl.com/",
"ContextName": null,
"TotalCount": 34,
"UniqueCount": 30,
"ContextDescription": null
},
{
"Context": "http://someUrl.com/product1/",
"ContextName": null,
"TotalCount": 95,
"UniqueCount": 67,
"ContextDescription": null
},
{
"Context": "http://someUrl.com/product2/",
"ContextName": null,
"TotalCount": 102,
"UniqueCount": 78,
"ContextDescription": null
},
{
"Context": "https://twitter.com/myCompany",
"ContextName": null,
"TotalCount": 89,
"UniqueCount": 89,
"ContextDescription": null
}
]
}
}
-
Code
- the response code. This is0
if successful. -
Error
- the response error message. This isnull
if successful. -
Context
- an object that contains all thePaging
andAnalytics
information for the campaign:-
Paging
- an object that contains the following information:-
PageSize
- the page size of the results. This is0
if not defined. -
CurrentPage
- the number of the result page. This is1
if not defined. -
Totalresults
- the number of results that are included in the response. -
TotalPageCount
- the total number of pages in your account. -
SortExpression
- the sort expression associated with the column or columns being sorted. -
SortIsAscending
- this isfalse
if the results are not displayed in ascending order based on the sort expression.
-
-
Analytics
- a list of links in your campaign containing the following information for each link:-
Context
- the URL of the link. -
ContextName
- this isnull
for this case. -
TotalCount
- the total number of link clicks. -
UniqueCount
- the total number of unique link clicks. -
ContextDescription
: This isnull
for this case.
-
-