[HTTP GET] ~/campaigns/{campaignId}/reports/landingpages
Description: Get a LandingPages Report for a specific Campaign
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| campaignId |
the specific Campaign Id |
integer |
Required |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
A LandingPage Channel Report
Response Content : LandingPageChannelReport
| Name | Description | Type | Additional information |
|---|---|---|---|
| LandingPageReports |
List of Child LandingPage Reports |
Collection of LandingPageReport |
None. |
| CampaignId |
The Campaign ID for this Report |
integer |
None. |
| StartDate |
The date this campaign Started |
date |
None. |
| EndDate |
The date this Campaig ended |
date |
None. |
| ViewCount |
The total number of views |
integer |
None. |
| ViewerCount |
The total number of viewers |
integer |
None. |
| ClickCount |
The total number of Clicks |
integer |
None. |
| ClickerCount |
The total number of Clickers |
integer |
None. |
| SubmissionCount |
The Total number of Submissions |
integer |
None. |
| WebFormViewCount |
The Total number of WebForm Views |
integer |
None. |
| AnonymousViewCount |
The Total number of Anonymous Views |
integer |
None. |
| ContactViewCount |
The Total number of Contact Views |
integer |
None. |
| AnonymousViewerCount |
The total number of Anonymous Viewers |
integer |
None. |
| ContactViewerCount |
The total number of Contact Viewers |
integer |
None. |
| AnonymousClickCount |
The total number of anonymous clicks |
integer |
None. |
| ContactClickCount |
The total number of contact clicks |
integer |
None. |
| AnonymousClickerCount |
The total number of Anonymous Clickers |
integer |
None. |
| ContactClickerCount |
The total number of Contact clickers |
integer |
None. |
| ClickRate |
The % of views that ended up as clicks |
decimal number |
None. |
| ClickerRate |
The % of Viewers that ended up as Clickers |
decimal number |
None. |
| SubmissionRate |
The % of Views that ended up in Submissions |
decimal number |
None. |
| WebFormViewRate |
The % of Views that were attached to WebForms |
decimal number |
None. |
Response Codes:
-
200 - OK
- The specified Campaign's LandingPage Report was retrieved and returned successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
404 - NotFound
- The specified Campaign or it's LandingPage report was not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
{
"LandingPageReports": [
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"ViewCount": 4,
"ViewerCount": 5,
"ClickCount": 6,
"ClickerCount": 7,
"SubmissionCount": 8,
"WebFormViewCount": 9,
"AnonymousViewCount": 10,
"ContactViewCount": 11,
"AnonymousViewerCount": 12,
"ContactViewerCount": 13,
"AnonymousClickCount": 14,
"ContactClickCount": 15,
"AnonymousClickerCount": 16,
"ContactClickerCount": 17,
"ClickRate": 18.1,
"ClickerRate": 19.1,
"SubmissionRate": 20.1,
"WebFormViewRate": 21.1
},
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"ViewCount": 4,
"ViewerCount": 5,
"ClickCount": 6,
"ClickerCount": 7,
"SubmissionCount": 8,
"WebFormViewCount": 9,
"AnonymousViewCount": 10,
"ContactViewCount": 11,
"AnonymousViewerCount": 12,
"ContactViewerCount": 13,
"AnonymousClickCount": 14,
"ContactClickCount": 15,
"AnonymousClickerCount": 16,
"ContactClickerCount": 17,
"ClickRate": 18.1,
"ClickerRate": 19.1,
"SubmissionRate": 20.1,
"WebFormViewRate": 21.1
}
],
"CampaignId": 1,
"StartDate": "2024-05-06T04:02:29.122442+01:00",
"EndDate": "2024-05-06T04:02:29.122442+01:00",
"ViewCount": 4,
"ViewerCount": 5,
"ClickCount": 6,
"ClickerCount": 7,
"SubmissionCount": 8,
"WebFormViewCount": 9,
"AnonymousViewCount": 10,
"ContactViewCount": 11,
"AnonymousViewerCount": 12,
"ContactViewerCount": 13,
"AnonymousClickCount": 14,
"ContactClickCount": 15,
"AnonymousClickerCount": 16,
"ContactClickerCount": 17,
"ClickRate": 18.1,
"ClickerRate": 19.1,
"SubmissionRate": 20.1,
"WebFormViewRate": 21.1
}
application/csp-report
Sample:
{"LandingPageReports":[{"Id":1,"Name":"sample string 2","Type":3,"ViewCount":4,"ViewerCount":5,"ClickCount":6,"ClickerCount":7,"SubmissionCount":8,"WebFormViewCount":9,"AnonymousViewCount":10,"ContactViewCount":11,"AnonymousViewerCount":12,"ContactViewerCount":13,"AnonymousClickCount":14,"ContactClickCount":15,"AnonymousClickerCount":16,"ContactClickerCount":17,"ClickRate":18.1,"ClickerRate":19.1,"SubmissionRate":20.1,"WebFormViewRate":21.1},{"Id":1,"Name":"sample string 2","Type":3,"ViewCount":4,"ViewerCount":5,"ClickCount":6,"ClickerCount":7,"SubmissionCount":8,"WebFormViewCount":9,"AnonymousViewCount":10,"ContactViewCount":11,"AnonymousViewerCount":12,"ContactViewerCount":13,"AnonymousClickCount":14,"ContactClickCount":15,"AnonymousClickerCount":16,"ContactClickerCount":17,"ClickRate":18.1,"ClickerRate":19.1,"SubmissionRate":20.1,"WebFormViewRate":21.1}],"CampaignId":1,"StartDate":"2024-05-06T04:02:29.122442+01:00","EndDate":"2024-05-06T04:02:29.122442+01:00","ViewCount":4,"ViewerCount":5,"ClickCount":6,"ClickerCount":7,"SubmissionCount":8,"WebFormViewCount":9,"AnonymousViewCount":10,"ContactViewCount":11,"AnonymousViewerCount":12,"ContactViewerCount":13,"AnonymousClickCount":14,"ContactClickCount":15,"AnonymousClickerCount":16,"ContactClickerCount":17,"ClickRate":18.1,"ClickerRate":19.1,"SubmissionRate":20.1,"WebFormViewRate":21.1}
application/xml, text/xml
Sample:
<LandingPageChannelReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Reports">
<AnonymousClickCount>14</AnonymousClickCount>
<AnonymousClickerCount>16</AnonymousClickerCount>
<AnonymousViewCount>10</AnonymousViewCount>
<AnonymousViewerCount>12</AnonymousViewerCount>
<CampaignId>1</CampaignId>
<ClickCount>6</ClickCount>
<ClickRate>18.1</ClickRate>
<ClickerCount>7</ClickerCount>
<ClickerRate>19.1</ClickerRate>
<ContactClickCount>15</ContactClickCount>
<ContactClickerCount>17</ContactClickerCount>
<ContactViewCount>11</ContactViewCount>
<ContactViewerCount>13</ContactViewerCount>
<EndDate>2024-05-06T04:02:29.122442+01:00</EndDate>
<LandingPageReports>
<LandingPageReport>
<AnonymousClickCount>14</AnonymousClickCount>
<AnonymousClickerCount>16</AnonymousClickerCount>
<AnonymousViewCount>10</AnonymousViewCount>
<AnonymousViewerCount>12</AnonymousViewerCount>
<ClickCount>6</ClickCount>
<ClickRate>18.1</ClickRate>
<ClickerCount>7</ClickerCount>
<ClickerRate>19.1</ClickerRate>
<ContactClickCount>15</ContactClickCount>
<ContactClickerCount>17</ContactClickerCount>
<ContactViewCount>11</ContactViewCount>
<ContactViewerCount>13</ContactViewerCount>
<Id>1</Id>
<Name>sample string 2</Name>
<SubmissionCount>8</SubmissionCount>
<SubmissionRate>20.1</SubmissionRate>
<Type>3</Type>
<ViewCount>4</ViewCount>
<ViewerCount>5</ViewerCount>
<WebFormViewCount>9</WebFormViewCount>
<WebFormViewRate>21.1</WebFormViewRate>
</LandingPageReport>
<LandingPageReport>
<AnonymousClickCount>14</AnonymousClickCount>
<AnonymousClickerCount>16</AnonymousClickerCount>
<AnonymousViewCount>10</AnonymousViewCount>
<AnonymousViewerCount>12</AnonymousViewerCount>
<ClickCount>6</ClickCount>
<ClickRate>18.1</ClickRate>
<ClickerCount>7</ClickerCount>
<ClickerRate>19.1</ClickerRate>
<ContactClickCount>15</ContactClickCount>
<ContactClickerCount>17</ContactClickerCount>
<ContactViewCount>11</ContactViewCount>
<ContactViewerCount>13</ContactViewerCount>
<Id>1</Id>
<Name>sample string 2</Name>
<SubmissionCount>8</SubmissionCount>
<SubmissionRate>20.1</SubmissionRate>
<Type>3</Type>
<ViewCount>4</ViewCount>
<ViewerCount>5</ViewerCount>
<WebFormViewCount>9</WebFormViewCount>
<WebFormViewRate>21.1</WebFormViewRate>
</LandingPageReport>
</LandingPageReports>
<StartDate>2024-05-06T04:02:29.122442+01:00</StartDate>
<SubmissionCount>8</SubmissionCount>
<SubmissionRate>20.1</SubmissionRate>
<ViewCount>4</ViewCount>
<ViewerCount>5</ViewerCount>
<WebFormViewCount>9</WebFormViewCount>
<WebFormViewRate>21.1</WebFormViewRate>
</LandingPageChannelReport>