| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/CampaignReports/{CampaignId}/Messages | Return the Campaign Report details. | |
|---|---|---|---|
| GET | /Ams/{ClientID}/CampaignReports/{CampaignId}/Messages/{MessageId} | Return a message's trace actions. | |
| GET | /Ams/{ClientID}/CampaignReports/{CampaignId} | Return the Campaign Report details. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | path | int | No | |
| MessageId | path | string | No | |
| ActivityFilter | query | int | No | |
| RequestAction | query | RequestAction | No | |
| FromDate | query | DateTime | No | |
| ToDate | query | DateTime | No | |
| TotalActivity | query | int | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Total | form | CampaignReportItem<int> | No | |
| Rate | form | CampaignReportItem<float> | No | |
| DailyTotal | form | List<CampaignReportItem<Int32>> | No | |
| DailyRate | form | List<CampaignReportItem<Single>> | No | |
| MessageActivity | form | List<CampaignReportMessageActivity> | No | |
| Messages | form | List<CampaignReportMessage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime? | No | |
| ListSize | form | T | No | |
| Process | form | T | No | |
| Send | form | T | No | |
| Delivery | form | T | No | |
| Open | form | T | No | |
| OpenUnique | form | T | No | |
| Click | form | T | No | |
| ClickUnique | form | T | No | |
| HardBounce | form | T | No | |
| SoftBounce | form | T | No | |
| Complaint | form | T | No | |
| CategoryOptOut | form | T | No | |
| EmailOptOut | form | T | No | |
| SuppressHardBounce | form | T | No | |
| SuppressCategoryOptOut | form | T | No | |
| SuppressEmailOptOut | form | T | No | |
| SuppressComplaint | form | T | No | |
| Fail | form | T | No | |
| Reject | form | T | No | |
| NotOpen | form | T | No | |
| NotSend | form | T | No | |
| Accountability | form | T | No | |
| EngagementScore | form | T | No | |
| SuccessRate | form | T | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeId | form | int | No | |
| Name | form | string | No | |
| Date | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberId | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| MessageGuid | form | string | No | |
| Activity | form | CampaignReportMessageActivity | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/CampaignReports/{CampaignId}/Messages HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Total:
{
Date: 0001-01-01,
ListSize: 0,
Process: 0,
Send: 0,
Delivery: 0,
Open: 0,
OpenUnique: 0,
Click: 0,
ClickUnique: 0,
HardBounce: 0,
SoftBounce: 0,
Complaint: 0,
CategoryOptOut: 0,
EmailOptOut: 0,
SuppressHardBounce: 0,
SuppressCategoryOptOut: 0,
SuppressEmailOptOut: 0,
SuppressComplaint: 0,
Fail: 0,
Reject: 0,
NotOpen: 0,
NotSend: 0,
Accountability: 0,
EngagementScore: 0,
SuccessRate: 0
},
Rate:
{
Date: 0001-01-01,
ListSize: 0,
Process: 0,
Send: 0,
Delivery: 0,
Open: 0,
OpenUnique: 0,
Click: 0,
ClickUnique: 0,
HardBounce: 0,
SoftBounce: 0,
Complaint: 0,
CategoryOptOut: 0,
EmailOptOut: 0,
SuppressHardBounce: 0,
SuppressCategoryOptOut: 0,
SuppressEmailOptOut: 0,
SuppressComplaint: 0,
Fail: 0,
Reject: 0,
NotOpen: 0,
NotSend: 0,
Accountability: 0,
EngagementScore: 0,
SuccessRate: 0
},
DailyTotal:
[
{
Date: 0001-01-01,
ListSize: 0,
Process: 0,
Send: 0,
Delivery: 0,
Open: 0,
OpenUnique: 0,
Click: 0,
ClickUnique: 0,
HardBounce: 0,
SoftBounce: 0,
Complaint: 0,
CategoryOptOut: 0,
EmailOptOut: 0,
SuppressHardBounce: 0,
SuppressCategoryOptOut: 0,
SuppressEmailOptOut: 0,
SuppressComplaint: 0,
Fail: 0,
Reject: 0,
NotOpen: 0,
NotSend: 0,
Accountability: 0,
EngagementScore: 0,
SuccessRate: 0
}
],
DailyRate:
[
{
Date: 0001-01-01,
ListSize: 0,
Process: 0,
Send: 0,
Delivery: 0,
Open: 0,
OpenUnique: 0,
Click: 0,
ClickUnique: 0,
HardBounce: 0,
SoftBounce: 0,
Complaint: 0,
CategoryOptOut: 0,
EmailOptOut: 0,
SuppressHardBounce: 0,
SuppressCategoryOptOut: 0,
SuppressEmailOptOut: 0,
SuppressComplaint: 0,
Fail: 0,
Reject: 0,
NotOpen: 0,
NotSend: 0,
Accountability: 0,
EngagementScore: 0,
SuccessRate: 0
}
],
MessageActivity:
[
{
TypeId: 0,
Name: String,
Date: 0001-01-01
}
],
Messages:
[
{
MemberId: 0,
FirstName: String,
LastName: String,
Email: String,
MessageGuid: String,
Activity:
{
TypeId: 0,
Name: String,
Date: 0001-01-01
}
}
],
CampaignId: 0,
MessageId: String,
ActivityFilter: 0,
RequestAction: Details,
FromDate: 0001-01-01,
ToDate: 0001-01-01,
TotalActivity: 0,
PageSize: 0,
PageNumber: 0,
UsingRedis: True,
AppInitTime: 2025-01-15T08:15:52.7673613-05:00,
ServerID: WS-5-99-907,
ClientID: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BypassCache: False,
DateCached: 2025-01-15T08:38:14.3707191-05:00,
Device: Desktop
}