dotmailer SDK: dotMailer.Sdk.Campaigns.DmCampaignSummary Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.Campaigns.DmCampaignSummary Class Reference

Summary for a campaign More...

Inheritance diagram for dotMailer.Sdk.Campaigns.DmCampaignSummary:
dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Properties

int AccountId [get, set]
 Id of the holding dotMailer account
 
int CampaignId [get, set]
 Id of the campaign that this information belongs to
 
int NumUniqueOpens [get, set]
 The number of HTML emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked
 
int NumUniqueTextOpens [get, set]
 The number of Plain Text emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked.
 
int NumTotalUniqueOpens [get, set]
 The total number of HTML and Plain Text emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked.
 
int NumOpens [get, set]
 How many times the HTML email you sent was tracked as being viewed. This could be the recipient opening it more than once or as a result of the email being forwarded to someone else at the same organisation.
 
int NumTextOpens [get, set]
 How many times the Plain Text email you sent was tracked as being viewed. This could be the recipient engaging with it more than once or as a result of the email being forwarded to someone else at the same organisation.
 
int NumTotalOpens [get, set]
 How many times the HTML and Plain Text email you sent was tracked as being viewed. This could be the recipient engaging with it more than once or as a result of the email being forwarded to someone else at the same organisation.
 
int NumClicks [get, set]
 The total number of links clicked in your HTML campaign. This would include users who had clicked a link more than once.
 
int NumTextClicks [get, set]
 The total number of links clicked in your Plain Text campaign. This would include users who had clicked a link more than once.
 
int NumTotalClicks [get, set]
 The total number of links clicked in your HTML and Plain Text campaign. This would include users who had clicked a link more than once
 
int NumPageViews [get, set]
 If you have used our page tracking code on your website then this reports the total page views generated by the HTML email campaign.
 
int NumTotalPageViews [get, set]
 If you have used our page tracking code on your website then this reports the total page views generated by the HTML and Plain Text email campaigns.
 
int NumTextPageViews [get, set]
 If you have used our page tracking code on your website then this reports the total page views generated by the Plain Text email campaign.
 
int NumForwards [get, set]
 This is the number of recipients who forwarded your HTML email onto a colleague or a friend using the "Forward to friend" link.
 
int NumTextForwards [get, set]
 This is the number of recipients who forwarded your Plain Text email onto a colleague or a friend using the "Forward to friend" link.
 
int NumEstimatedForwards [get, set]
 This is the number of times the HTML email was forwarded based on the system registering an open in a different email client and IP address to the original recipient of the email.
 
int NumTextEstimatedForwards [get, set]
 This is the number of times the Plain Text email was forwarded based on the system registering engagement in a different email client and IP address to the original recipient of the email
 
int NumTotalEstimatedForwards [get, set]
 This is the number of times the HTML email and Plain Text email were forwarded based on the system registering engagement in a different email client and IP address to the original recipient of the email
 
int NumReplies [get, set]
 This is the number of replies received to the HTML email.
 
int NumTextReplies [get, set]
 This is the number of replies received to the Plain Text email.
 
int NumTotalReplies [get, set]
 This is the number of replies received to the HTML and Plain Text emails.
 
int NumHardBounces [get, set]
 This is the number of hard bounces received to the HTML email.
 
int NumTextHardBounces [get, set]
 This is the number of hard bounces received to the Plain Text email.
 
int NumTotalHardBounces [get, set]
 This is the total number of hard bounces received to the HTML and Plain Text emails.
 
int NumSoftBounces [get, set]
 This is the number of soft bounces received to the HTML email.
 
int NumTextSoftBounces [get, set]
 This is the number of soft bounces received to the Plain Text email.
 
int NumTotalSoftBounces [get, set]
 This is the total number of soft bounces received to the HTML and Plain Text emails.
 
int NumUnsubscribes [get, set]
 The number of contacts who, having received the HTML email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature.
 
int NumTextUnsubscribes [get, set]
 The number of contacts who, having received the Plain Text email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature
 
int NumTotalUnsubscribes [get, set]
 The number of contacts who, having received the HTML or Plain Text email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature.
 
int NumIspComplaints [get, set]
 The number of contacts whom their ISP have informed us reported the HTML email as spam/junk
 
int NumTextIspComplaints [get, set]
 The number of contacts whom their ISP have informed us reported the Plain Text email as spam/junk.
 
int NumTotalIspComplaints [get, set]
 The number of contacts whom their ISP have informed us reported the HTML or Plain Text email as spam/junk.
 
int NumMailBlocks [get, set]
 The number of HTML emails not delivered where the receiving mail server explicitly told us your email was blocked.
 
int NumTextMailBlocks [get, set]
 The number of Plain Text emails not delivered where the receiving mail server explicitly told us your email was blocked.
 
int NumTotalMailBlocks [get, set]
 The number of HTML and Plain Text emails not delivered where the receiving mail server explicitly told us your email was blocked.
 
int NumSent [get, set]
 This shows the number of HTML emails sent for the campaign.
 
int NumTextSent [get, set]
 This shows the number of Plain Text emails sent for the campaign.
 
int NumTotalSent [get, set]
 This shows the number of emails sent for the campaign.
 
int NumRecipientsClicked [get, set]
 This shows the total number of recipients clicking on at least one link in the campaign.
 
int NumDelivered [get, set]
 This shows the number of HTML emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.
 
int NumTextDelivered [get, set]
 This shows the number of Plain Text emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.
 
int NumTotalDelivered [get, set]
 This shows the number of HTML and Plain Text emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.
 
DateTime DateSent [get, set]
 This shows the date and time that the campaign was first sent - if it was sent to additional recipients after first send, this date will not change.
 
double PercentageDelivered [get, set]
 The percentage of emails that did not bounce.
 
double PercentageUniqueOpens [get, set]
 The percentage of contacts tracked as having opened the email at least once.
 
double PercentageOpens [get, set]
 The total number of tracked opens for the campaign expressed as a percentage of the number of emails delivered.
 
double PercentageUnsubscribes [get, set]
 The percentage of contacts receiving the campaign who unsubscribed using the unsubscribe link or ISP junk/spam feature.
 
double PercentageReplies [get, set]
 The percentage of contacts replying to the campaign.
 
double PercentageHardBounces [get, set]
 The percentage of contacts sent the campaign for which a hard bounce was received.
 
double PercentageSoftBounces [get, set]
 The percentage of contacts sent the campaign for which a soft bounce was received.
 
double PercentageUsersClicked [get, set]
 The percentage of contacts for the campaign that clicked on at least one link.
 
double PercentageClicksToOpens [get, set]
 The total number of clicks on the campaign as a percentage of the total number of times the email was tracked as open.
 
string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
bool IsDirty [get]
 Returns true if the object has changed
 
string ObjectType [get, set]
 Returns the type name of the class Used by the serialisation process
 
string ExternalId [get]
 Gets/Sets the generated Id that uniquely identifies this record
 
- Properties inherited from dotMailer.Sdk.Interfaces.IDmObject
int AccountId [get]
 The DotMailer account Id for this object
 
string ExternalId [get]
 A key that represents this object, used for synching with external applications
 
bool IsDirty [get]
 has the data of the object changed
 

Detailed Description

Summary for a campaign

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaignSummary.AccountId
getset

Id of the holding dotMailer account

int dotMailer.Sdk.Campaigns.DmCampaignSummary.CampaignId
getset

Id of the campaign that this information belongs to

DateTime dotMailer.Sdk.Campaigns.DmCampaignSummary.DateSent
getset

This shows the date and time that the campaign was first sent - if it was sent to additional recipients after first send, this date will not change.

string dotMailer.Sdk.Campaigns.DmCampaignSummary.ExternalId
get

Gets/Sets the generated Id that uniquely identifies this record

bool dotMailer.Sdk.Campaigns.DmCampaignSummary.IsDirty
get

Returns true if the object has changed

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumClicks
getset

The total number of links clicked in your HTML campaign. This would include users who had clicked a link more than once.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumDelivered
getset

This shows the number of HTML emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumEstimatedForwards
getset

This is the number of times the HTML email was forwarded based on the system registering an open in a different email client and IP address to the original recipient of the email.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumForwards
getset

This is the number of recipients who forwarded your HTML email onto a colleague or a friend using the "Forward to friend" link.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumHardBounces
getset

This is the number of hard bounces received to the HTML email.

A hard bounce is an invalid email address and will be placed in the suppression list.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumIspComplaints
getset

The number of contacts whom their ISP have informed us reported the HTML email as spam/junk

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumMailBlocks
getset

The number of HTML emails not delivered where the receiving mail server explicitly told us your email was blocked.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumOpens
getset

How many times the HTML email you sent was tracked as being viewed. This could be the recipient opening it more than once or as a result of the email being forwarded to someone else at the same organisation.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumPageViews
getset

If you have used our page tracking code on your website then this reports the total page views generated by the HTML email campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumRecipientsClicked
getset

This shows the total number of recipients clicking on at least one link in the campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumReplies
getset

This is the number of replies received to the HTML email.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumSent
getset

This shows the number of HTML emails sent for the campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumSoftBounces
getset

This is the number of soft bounces received to the HTML email.

A soft bounce is an email address where delivery was unsuccessful but it doesn't necessarily mean the email is invalid.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextClicks
getset

The total number of links clicked in your Plain Text campaign. This would include users who had clicked a link more than once.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextDelivered
getset

This shows the number of Plain Text emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextEstimatedForwards
getset

This is the number of times the Plain Text email was forwarded based on the system registering engagement in a different email client and IP address to the original recipient of the email

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextForwards
getset

This is the number of recipients who forwarded your Plain Text email onto a colleague or a friend using the "Forward to friend" link.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextHardBounces
getset

This is the number of hard bounces received to the Plain Text email.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextIspComplaints
getset

The number of contacts whom their ISP have informed us reported the Plain Text email as spam/junk.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextMailBlocks
getset

The number of Plain Text emails not delivered where the receiving mail server explicitly told us your email was blocked.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextOpens
getset

How many times the Plain Text email you sent was tracked as being viewed. This could be the recipient engaging with it more than once or as a result of the email being forwarded to someone else at the same organisation.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextPageViews
getset

If you have used our page tracking code on your website then this reports the total page views generated by the Plain Text email campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextReplies
getset

This is the number of replies received to the Plain Text email.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextSent
getset

This shows the number of Plain Text emails sent for the campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextSoftBounces
getset

This is the number of soft bounces received to the Plain Text email.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTextUnsubscribes
getset

The number of contacts who, having received the Plain Text email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalClicks
getset

The total number of links clicked in your HTML and Plain Text campaign. This would include users who had clicked a link more than once

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalDelivered
getset

This shows the number of HTML and Plain Text emails delivered to their intended recipients. This number is achieved by taking the total number sent minus any hard or soft bouncers.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalEstimatedForwards
getset

This is the number of times the HTML email and Plain Text email were forwarded based on the system registering engagement in a different email client and IP address to the original recipient of the email

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalHardBounces
getset

This is the total number of hard bounces received to the HTML and Plain Text emails.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalIspComplaints
getset

The number of contacts whom their ISP have informed us reported the HTML or Plain Text email as spam/junk.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalMailBlocks
getset

The number of HTML and Plain Text emails not delivered where the receiving mail server explicitly told us your email was blocked.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalOpens
getset

How many times the HTML and Plain Text email you sent was tracked as being viewed. This could be the recipient engaging with it more than once or as a result of the email being forwarded to someone else at the same organisation.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalPageViews
getset

If you have used our page tracking code on your website then this reports the total page views generated by the HTML and Plain Text email campaigns.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalReplies
getset

This is the number of replies received to the HTML and Plain Text emails.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalSent
getset

This shows the number of emails sent for the campaign.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalSoftBounces
getset

This is the total number of soft bounces received to the HTML and Plain Text emails.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalUniqueOpens
getset

The total number of HTML and Plain Text emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumTotalUnsubscribes
getset

The number of contacts who, having received the HTML or Plain Text email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumUniqueOpens
getset

The number of HTML emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumUniqueTextOpens
getset

The number of Plain Text emails tracked as being opened at least once. This is a worse case scenario as not all email clients or business email servers allow emails to be tracked.

int dotMailer.Sdk.Campaigns.DmCampaignSummary.NumUnsubscribes
getset

The number of contacts who, having received the HTML email, have unsubscribed from your list by using the unsubscribe link or 'remove me from this mailing list' feature.

string dotMailer.Sdk.Campaigns.DmCampaignSummary.ObjectType
getset

Returns the type name of the class Used by the serialisation process

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageClicksToOpens
getset

The total number of clicks on the campaign as a percentage of the total number of times the email was tracked as open.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageDelivered
getset

The percentage of emails that did not bounce.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageHardBounces
getset

The percentage of contacts sent the campaign for which a hard bounce was received.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageOpens
getset

The total number of tracked opens for the campaign expressed as a percentage of the number of emails delivered.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageReplies
getset

The percentage of contacts replying to the campaign.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageSoftBounces
getset

The percentage of contacts sent the campaign for which a soft bounce was received.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageUniqueOpens
getset

The percentage of contacts tracked as having opened the email at least once.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageUnsubscribes
getset

The percentage of contacts receiving the campaign who unsubscribed using the unsubscribe link or ISP junk/spam feature.

double dotMailer.Sdk.Campaigns.DmCampaignSummary.PercentageUsersClicked
getset

The percentage of contacts for the campaign that clicked on at least one link.

string dotMailer.Sdk.Campaigns.DmCampaignSummary.UserTag1
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignSummary.UserTag2
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignSummary.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3