[HTTP GET] ~/campaigns/{campaignId}/reports/emails
Description: Get an Emails 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):
An Email Channel Report
Response Content : EmailChannelReport
| Name | Description | Type | Additional information |
|---|---|---|---|
| EmailReports |
List of child Email Reports |
Collection of EmailReport |
None. |
| CampaignId | integer |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| EmailCount |
Total number of emails |
integer |
None. |
| Sent |
How many emails were sent |
integer |
None. |
| Delivered |
How many emails were delivered |
integer |
None. |
| Bounced |
How many emails were bounced |
integer |
None. |
| Opened |
How many emails were opened |
integer |
None. |
| Read |
How many emails were read |
integer |
None. |
| Clicked |
How many emails were clicked |
integer |
None. |
| DidntClick |
How many emails were not clicked |
integer |
None. |
| TotalClicks |
Total count of clicks |
integer |
None. |
| TotalUnsubscribes |
Total count of unsubscribes |
integer |
None. |
| UserUnsubscribes |
Total number of user unsubscribes |
integer |
None. |
| AutoUnsubscribes |
Total number of auto unsubscribes |
integer |
None. |
| AbuseComplaints |
How many abus completes where made |
integer |
None. |
| SentToFriends |
How many were sent to friends |
integer |
None. |
| ReferredBy |
Reference referred |
integer |
None. |
| SentRate |
% of Emails send |
decimal number |
None. |
| DeliveredRate |
% of Emails delivered |
decimal number |
None. |
| BouncedRate |
% of emails bounced |
decimal number |
None. |
| OpenedRate |
% of emails opened |
decimal number |
None. |
| UnopenedRate |
% of emails unopened |
decimal number |
None. |
| ReadRate |
% of emails read |
decimal number |
None. |
| ClickedRate |
% of emails clicked |
decimal number |
None. |
| TotalClicksRate |
% of Total clicks |
decimal number |
None. |
| DidntClickRate |
% of emails not clicked |
decimal number |
None. |
| UnsubscribeRate |
% of Emails unsubscribed |
decimal number |
None. |
| ComplaintRate |
% of emails sent that resulted in complaint |
decimal number |
None. |
| ReferralRate |
% of emails referred |
decimal number |
None. |
Response Codes:
-
200 - OK
- The specified Campaign's Email Reports were 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 Email reports were not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
{
"EmailReports": [
{
"Id": 1,
"Name": "sample string 2",
"CampaignId": 3,
"StartDate": "2024-05-06T09:09:04.7540952+01:00",
"EndDate": "2024-05-06T09:09:04.7540952+01:00",
"Subject": "sample string 6",
"FromName": "sample string 7",
"DayOfWeek": "sample string 8",
"FromEmail": "sample string 9",
"EmailCount": 10,
"Sent": 11,
"Delivered": 12,
"Bounced": 13,
"Opened": 14,
"Read": 15,
"Clicked": 16,
"DidntClick": 17,
"TotalClicks": 18,
"TotalUnsubscribes": 19,
"UserUnsubscribes": 20,
"AutoUnsubscribes": 21,
"AbuseComplaints": 22,
"SentToFriends": 23,
"ReferredBy": 1,
"SentRate": 24.1,
"DeliveredRate": 25.1,
"BouncedRate": 26.1,
"OpenedRate": 27.1,
"UnopenedRate": 28.1,
"ReadRate": 29.1,
"ClickedRate": 30.1,
"ClickedThruRate": 31.1,
"TotalClicksRate": 32.1,
"DidntClickRate": 33.1,
"UnsubscribeRate": 34.1,
"UserUnsubscribeRate": 35.1,
"AutoUnsubscribeRate": 36.1,
"ComplaintRate": 37.1,
"ReferralRate": 38.1
},
{
"Id": 1,
"Name": "sample string 2",
"CampaignId": 3,
"StartDate": "2024-05-06T09:09:04.7540952+01:00",
"EndDate": "2024-05-06T09:09:04.7540952+01:00",
"Subject": "sample string 6",
"FromName": "sample string 7",
"DayOfWeek": "sample string 8",
"FromEmail": "sample string 9",
"EmailCount": 10,
"Sent": 11,
"Delivered": 12,
"Bounced": 13,
"Opened": 14,
"Read": 15,
"Clicked": 16,
"DidntClick": 17,
"TotalClicks": 18,
"TotalUnsubscribes": 19,
"UserUnsubscribes": 20,
"AutoUnsubscribes": 21,
"AbuseComplaints": 22,
"SentToFriends": 23,
"ReferredBy": 1,
"SentRate": 24.1,
"DeliveredRate": 25.1,
"BouncedRate": 26.1,
"OpenedRate": 27.1,
"UnopenedRate": 28.1,
"ReadRate": 29.1,
"ClickedRate": 30.1,
"ClickedThruRate": 31.1,
"TotalClicksRate": 32.1,
"DidntClickRate": 33.1,
"UnsubscribeRate": 34.1,
"UserUnsubscribeRate": 35.1,
"AutoUnsubscribeRate": 36.1,
"ComplaintRate": 37.1,
"ReferralRate": 38.1
}
],
"CampaignId": 1,
"StartDate": "2024-05-06T09:09:04.7540952+01:00",
"EndDate": "2024-05-06T09:09:04.7540952+01:00",
"EmailCount": 4,
"Sent": 5,
"Delivered": 6,
"Bounced": 7,
"Opened": 8,
"Read": 9,
"Clicked": 10,
"DidntClick": 11,
"TotalClicks": 12,
"TotalUnsubscribes": 13,
"UserUnsubscribes": 14,
"AutoUnsubscribes": 15,
"AbuseComplaints": 16,
"SentToFriends": 17,
"ReferredBy": 1,
"SentRate": 18.1,
"DeliveredRate": 19.1,
"BouncedRate": 20.1,
"OpenedRate": 21.1,
"UnopenedRate": 22.1,
"ReadRate": 23.1,
"ClickedRate": 24.1,
"TotalClicksRate": 25.1,
"DidntClickRate": 26.1,
"UnsubscribeRate": 27.1,
"ComplaintRate": 28.1,
"ReferralRate": 29.1
}
application/csp-report
Sample:
{"EmailReports":[{"Id":1,"Name":"sample string 2","CampaignId":3,"StartDate":"2024-05-06T09:09:04.7540952+01:00","EndDate":"2024-05-06T09:09:04.7540952+01:00","Subject":"sample string 6","FromName":"sample string 7","DayOfWeek":"sample string 8","FromEmail":"sample string 9","EmailCount":10,"Sent":11,"Delivered":12,"Bounced":13,"Opened":14,"Read":15,"Clicked":16,"DidntClick":17,"TotalClicks":18,"TotalUnsubscribes":19,"UserUnsubscribes":20,"AutoUnsubscribes":21,"AbuseComplaints":22,"SentToFriends":23,"ReferredBy":1,"SentRate":24.1,"DeliveredRate":25.1,"BouncedRate":26.1,"OpenedRate":27.1,"UnopenedRate":28.1,"ReadRate":29.1,"ClickedRate":30.1,"ClickedThruRate":31.1,"TotalClicksRate":32.1,"DidntClickRate":33.1,"UnsubscribeRate":34.1,"UserUnsubscribeRate":35.1,"AutoUnsubscribeRate":36.1,"ComplaintRate":37.1,"ReferralRate":38.1},{"Id":1,"Name":"sample string 2","CampaignId":3,"StartDate":"2024-05-06T09:09:04.7540952+01:00","EndDate":"2024-05-06T09:09:04.7540952+01:00","Subject":"sample string 6","FromName":"sample string 7","DayOfWeek":"sample string 8","FromEmail":"sample string 9","EmailCount":10,"Sent":11,"Delivered":12,"Bounced":13,"Opened":14,"Read":15,"Clicked":16,"DidntClick":17,"TotalClicks":18,"TotalUnsubscribes":19,"UserUnsubscribes":20,"AutoUnsubscribes":21,"AbuseComplaints":22,"SentToFriends":23,"ReferredBy":1,"SentRate":24.1,"DeliveredRate":25.1,"BouncedRate":26.1,"OpenedRate":27.1,"UnopenedRate":28.1,"ReadRate":29.1,"ClickedRate":30.1,"ClickedThruRate":31.1,"TotalClicksRate":32.1,"DidntClickRate":33.1,"UnsubscribeRate":34.1,"UserUnsubscribeRate":35.1,"AutoUnsubscribeRate":36.1,"ComplaintRate":37.1,"ReferralRate":38.1}],"CampaignId":1,"StartDate":"2024-05-06T09:09:04.7540952+01:00","EndDate":"2024-05-06T09:09:04.7540952+01:00","EmailCount":4,"Sent":5,"Delivered":6,"Bounced":7,"Opened":8,"Read":9,"Clicked":10,"DidntClick":11,"TotalClicks":12,"TotalUnsubscribes":13,"UserUnsubscribes":14,"AutoUnsubscribes":15,"AbuseComplaints":16,"SentToFriends":17,"ReferredBy":1,"SentRate":18.1,"DeliveredRate":19.1,"BouncedRate":20.1,"OpenedRate":21.1,"UnopenedRate":22.1,"ReadRate":23.1,"ClickedRate":24.1,"TotalClicksRate":25.1,"DidntClickRate":26.1,"UnsubscribeRate":27.1,"ComplaintRate":28.1,"ReferralRate":29.1}
application/xml, text/xml
Sample:
<EmailChannelReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Reports">
<AbuseComplaints>16</AbuseComplaints>
<AutoUnsubscribes>15</AutoUnsubscribes>
<Bounced>7</Bounced>
<BouncedRate>20.1</BouncedRate>
<CampaignId>1</CampaignId>
<Clicked>10</Clicked>
<ClickedRate>24.1</ClickedRate>
<ComplaintRate>28.1</ComplaintRate>
<Delivered>6</Delivered>
<DeliveredRate>19.1</DeliveredRate>
<DidntClick>11</DidntClick>
<DidntClickRate>26.1</DidntClickRate>
<EmailCount>4</EmailCount>
<EmailReports>
<EmailReport>
<AbuseComplaints>22</AbuseComplaints>
<AutoUnsubscribeRate>36.1</AutoUnsubscribeRate>
<AutoUnsubscribes>21</AutoUnsubscribes>
<Bounced>13</Bounced>
<BouncedRate>26.1</BouncedRate>
<CampaignId>3</CampaignId>
<Clicked>16</Clicked>
<ClickedRate>30.1</ClickedRate>
<ClickedThruRate>31.1</ClickedThruRate>
<ComplaintRate>37.1</ComplaintRate>
<DayOfWeek>sample string 8</DayOfWeek>
<Delivered>12</Delivered>
<DeliveredRate>25.1</DeliveredRate>
<DidntClick>17</DidntClick>
<DidntClickRate>33.1</DidntClickRate>
<EmailCount>10</EmailCount>
<EndDate>2024-05-06T09:09:04.7540952+01:00</EndDate>
<FromEmail>sample string 9</FromEmail>
<FromName>sample string 7</FromName>
<Id>1</Id>
<Name>sample string 2</Name>
<Opened>14</Opened>
<OpenedRate>27.1</OpenedRate>
<Read>15</Read>
<ReadRate>29.1</ReadRate>
<ReferralRate>38.1</ReferralRate>
<ReferredBy>1</ReferredBy>
<Sent>11</Sent>
<SentRate>24.1</SentRate>
<SentToFriends>23</SentToFriends>
<StartDate>2024-05-06T09:09:04.7540952+01:00</StartDate>
<Subject>sample string 6</Subject>
<TotalClicks>18</TotalClicks>
<TotalClicksRate>32.1</TotalClicksRate>
<TotalUnsubscribes>19</TotalUnsubscribes>
<UnopenedRate>28.1</UnopenedRate>
<UnsubscribeRate>34.1</UnsubscribeRate>
<UserUnsubscribeRate>35.1</UserUnsubscribeRate>
<UserUnsubscribes>20</UserUnsubscribes>
</EmailReport>
<EmailReport>
<AbuseComplaints>22</AbuseComplaints>
<AutoUnsubscribeRate>36.1</AutoUnsubscribeRate>
<AutoUnsubscribes>21</AutoUnsubscribes>
<Bounced>13</Bounced>
<BouncedRate>26.1</BouncedRate>
<CampaignId>3</CampaignId>
<Clicked>16</Clicked>
<ClickedRate>30.1</ClickedRate>
<ClickedThruRate>31.1</ClickedThruRate>
<ComplaintRate>37.1</ComplaintRate>
<DayOfWeek>sample string 8</DayOfWeek>
<Delivered>12</Delivered>
<DeliveredRate>25.1</DeliveredRate>
<DidntClick>17</DidntClick>
<DidntClickRate>33.1</DidntClickRate>
<EmailCount>10</EmailCount>
<EndDate>2024-05-06T09:09:04.7540952+01:00</EndDate>
<FromEmail>sample string 9</FromEmail>
<FromName>sample string 7</FromName>
<Id>1</Id>
<Name>sample string 2</Name>
<Opened>14</Opened>
<OpenedRate>27.1</OpenedRate>
<Read>15</Read>
<ReadRate>29.1</ReadRate>
<ReferralRate>38.1</ReferralRate>
<ReferredBy>1</ReferredBy>
<Sent>11</Sent>
<SentRate>24.1</SentRate>
<SentToFriends>23</SentToFriends>
<StartDate>2024-05-06T09:09:04.7540952+01:00</StartDate>
<Subject>sample string 6</Subject>
<TotalClicks>18</TotalClicks>
<TotalClicksRate>32.1</TotalClicksRate>
<TotalUnsubscribes>19</TotalUnsubscribes>
<UnopenedRate>28.1</UnopenedRate>
<UnsubscribeRate>34.1</UnsubscribeRate>
<UserUnsubscribeRate>35.1</UserUnsubscribeRate>
<UserUnsubscribes>20</UserUnsubscribes>
</EmailReport>
</EmailReports>
<EndDate>2024-05-06T09:09:04.7540952+01:00</EndDate>
<Opened>8</Opened>
<OpenedRate>21.1</OpenedRate>
<Read>9</Read>
<ReadRate>23.1</ReadRate>
<ReferralRate>29.1</ReferralRate>
<ReferredBy>1</ReferredBy>
<Sent>5</Sent>
<SentRate>18.1</SentRate>
<SentToFriends>17</SentToFriends>
<StartDate>2024-05-06T09:09:04.7540952+01:00</StartDate>
<TotalClicks>12</TotalClicks>
<TotalClicksRate>25.1</TotalClicksRate>
<TotalUnsubscribes>13</TotalUnsubscribes>
<UnopenedRate>22.1</UnopenedRate>
<UnsubscribeRate>27.1</UnsubscribeRate>
<UserUnsubscribes>14</UserUnsubscribes>
</EmailChannelReport>