POST api/Campaigns/GetEmailPerformance

Within Digital Communication Product Suite application, each email that has been sent has an Email Performance report that gives information about the email and interactions from the recipients. You can use this to get information on reusable “Triggered” emails only.

Request Information

URI Parameters

None.

Body Parameters

EmailPerformanceRequestModel
NameDescriptionTypeAdditional information
EmailID

A unique identifier for the email campaign. Use the GetEmails API obtain the email id if you want to pull performance statistics for a specific email (this will show reusable "Triggered" emails only).

 string

None.
CampaignID

An internal unique identifier for the email campaign

 string

None.
StartDate

Starting date range. If you do not provide a date, this will default to 90 days in the past

 date

None.
EndDate

Ending date range. If you do not provide a date, this will default to the current date and time

 date

None.

Request Formats

application/json, text/json

Sample: 
{
  "EmailID": "sample string 1",
  "CampaignID": "sample string 2",
  "StartDate": "2025-10-23T21:12:16.2660404-06:00",
  "EndDate": "2025-10-23T21:12:16.2660404-06:00"
}

application/xml, text/xml

Sample: 
<EmailPerformanceRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailID>sample string 1</EmailID>
  <CampaignID>sample string 2</CampaignID>
  <StartDate>2025-10-23T21:12:16.2660404-06:00</StartDate>
  <EndDate>2025-10-23T21:12:16.2660404-06:00</EndDate>
</EmailPerformanceRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns Number of emails sent, Number of emails where we received a bounce back message saying the email couldn’t be delivered, Number of people who clicked on any link, Number of total clicks, Clickthrough rate, and other statistics

EmailPerformanceResponseModel
NameDescriptionTypeAdditional information
CompanyID

Unique identifier for your Digital Communication account

 string

None.
CampaignID

Internal unique identifier for the email

 string

None.
EmailID

Unique indicator pointing to the email

 string

None.
CampaignName

The name given to the email when creating the email, if you have a user interface where the user confirms which email they want to send, the email name is a more user-friendly name to display.

 string

None.
CreatedDate

The date the email was created

 date

None.
PublishDate

The date the email was published

 date

None.
VersionCode

This is used for the Marketing Data Platform/ExecuTrax integration process

 string

None.
Subject

This is the subject defined for the email

 string

None.
From

The from name used on the delivered email

 string

None.
FromEmail

The email address that the email was from

 string

None.
ReplyToEmail

The reply to email address on the email, this can be changed per email and/or per email delivery

 string

None.
MailSize

Within the timeframe, the number of email addresses uploaded to be sent

 decimal number

None.
Delivered

Within the timeframe, the number of emails sent

 decimal number

None.
TotalOpens

The total number of emails opened since the email was delivered, this will include a count of each time a recipient opened the email (this is not limited to the timeframe)

 decimal number

None.
UniqueOpens

The count of individuals who opened the email at least once since the email was delivered (this is not limited to the timeframe)

 decimal number

None.
UniqueOpensPercent

The percent of unique opens to actual delivered (delivered – undelivered) emails

 decimal number

None.
Unopened

The number of emails that were not opened (not including the emails that were undelivered (this is not limited to the timeframe)

 decimal number

None.
UnopenedPercent

The percent of unopened emails compared to actual delivered (delivered – undelivered) emails

 decimal number

None.
TotalClickThroughs

The total number of links clicked since the email was delivered, this will include a count of each time a recipient clicked any link (this is not limited to the timeframe)

 decimal number

None.
UniqueClickThroughs

The count of individuals who clicked on one or more links since the email was delivered (this is not limited to the timeframe)

 decimal number

None.
ClickThroughPercent

The percent of individuals who clicked on a link compared to the delivered emails

 decimal number

None.
Undeliverable

The number of emails where Marquis received a bounce back stating that the email could not be delivered (this is not limited to the timeframe)

 decimal number

None.
UndeliverablePercent

The percent of undelivered emails compared to emails sent

 decimal number

None.
Unsubscribed

The count of individuals who unsubscribed using the link at the bottom of the email (this is not limited to the timeframe)

 decimal number

None.
UnsubscribedPercent

The percent of individuals who unsubscribed compared to emails sent

 decimal number

None.
CTOR

The Click-to-Open-Ratio, the percent of the individual who opened an email and also clicked on a link (this is not limited to the timeframe)

 decimal number

None.
Rejected

Within the timeframe, the number of email addresses uploaded to be sent but couldn’t be sent for a variety of reasons (e.g., the email address is invalid, has a known invalid domain, is on the permanently blocked list, has previously unsubscribed, etc.)

 decimal number

None.
IsSuccessful

Indicator of whether the request was successful

 boolean

None.
ErrorMessage

This will contain details of the error if it was not successful

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 20",
  "CompanyID": "sample string 1",
  "CampaignID": "sample string 2",
  "EmailID": "sample string 3",
  "CampaignName": "sample string 4",
  "CreatedDate": "2025-10-23T21:12:16.2660404-06:00",
  "PublishDate": "2025-10-23T21:12:16.2660404-06:00",
  "VersionCode": "sample string 5",
  "Subject": "sample string 6",
  "From": "sample string 7",
  "FromEmail": "sample string 8",
  "ReplyToEmail": "sample string 9",
  "MailSize": 10.1,
  "Delivered": 11.1,
  "TotalOpens": 12.1,
  "UniqueOpens": 13.1,
  "UniqueOpensPercent": -262.0,
  "Unopened": -2.0,
  "UnopenedPercent": 0.0,
  "TotalClickThroughs": 14.1,
  "UniqueClickThroughs": 15.1,
  "ClickThroughPercent": -302.0,
  "Undeliverable": 16.1,
  "UndeliverablePercent": 145.0,
  "Unsubscribed": 17.1,
  "UnsubscribedPercent": 154.1,
  "CTOR": 115.3,
  "Rejected": 18.1
}

application/xml, text/xml

Sample: 
<EmailPerformanceResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 20</ErrorMessage>
  <CompanyID>sample string 1</CompanyID>
  <CampaignID>sample string 2</CampaignID>
  <EmailID>sample string 3</EmailID>
  <CampaignName>sample string 4</CampaignName>
  <CreatedDate>2025-10-23T21:12:16.2660404-06:00</CreatedDate>
  <PublishDate>2025-10-23T21:12:16.2660404-06:00</PublishDate>
  <VersionCode>sample string 5</VersionCode>
  <Subject>sample string 6</Subject>
  <From>sample string 7</From>
  <FromEmail>sample string 8</FromEmail>
  <ReplyToEmail>sample string 9</ReplyToEmail>
  <MailSize>10.1</MailSize>
  <Delivered>11.1</Delivered>
  <TotalOpens>12.1</TotalOpens>
  <UniqueOpens>13.1</UniqueOpens>
  <TotalClickThroughs>14.1</TotalClickThroughs>
  <UniqueClickThroughs>15.1</UniqueClickThroughs>
  <Undeliverable>16.1</Undeliverable>
  <Unsubscribed>17.1</Unsubscribed>
  <Rejected>18.1</Rejected>
</EmailPerformanceResponseModel>