Name | Type | Description | Constraints |
|---|
messageId | Long | The message ID. | required |
messageName | String | The name of the message. | required |
messageSubject | String | The message subject line. | required |
groupName | String | Name of the group to which the message was sent. | required |
sendout | Long | The date and time on which the sendout was started. | required |
confirmedOpens | Long | The total number of times a message was opened. | required |
confirmedOpeners | Long | The number of recipients who opened a message. | required |
totalClicks | Long | The total number of clicks on a link. | required |
clickers | Long | The number of recipients who have clicked on any link in the message. | required |
acceptedMessages | Long | The number of messages that were accepted by the email provider's Message Transfer Agent (MTA). | required |
messagesOpened | Long | The number of recipients who have opened a message. | required |
messagesClicked | Long | The number of recipients who have clicked on any link in the message. | required |
timeFrameStart | Long | The start of the time period for which statistics are reported. | required |
timeFrameEnd | Long | The end of the time period for which statistics are reported. | required |
interval | TimeDistributionInterval | An enumerated type object that determines the interval for which message statistics are aggregated. Available aggregations are daily or hourly. | required |
periods | MessageTimeDistributionPeriod | A list of MessageTimeDistributionPeriod objects that refer to statistical data points within the time frame. | required |
