public class MaileonReportsService extends AbstractMaileonService
MaileonReportsService
client send operational requests to the ReportsResource
.AbstractMaileonService.QueryParameters
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SERVICE |
MAILEON_XML_TYPE
Constructor and Description |
---|
MaileonReportsService(MaileonConfiguration config)
Instantiates a new maileon reports service.
|
Modifier and Type | Method and Description |
---|---|
Page<Block> |
getBlocks(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
java.util.List<java.lang.String> reasons,
java.lang.String oldStatus,
java.lang.String newStatus,
boolean excludeAnonymousBlocks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of block status changes.
|
int |
getBlocksCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
java.util.List<java.lang.String> reasons,
java.lang.String oldStatus,
java.lang.String newStatus,
boolean excludeAnonymousBlocks)
Returns the number of blocks.
|
Page<Bounce> |
getBounces(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeAnonymousBounces,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of bounces.
|
Page<Bounce> |
getBounces(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
java.util.List<java.lang.String> statusCodeFilter,
java.lang.String typeFilter,
java.lang.String sourceFilter,
boolean excludeAnonymousBounces,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of bounces.
|
Page<Click> |
getClicks(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousClicks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of clicks.
|
Page<Click> |
getClicks(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
Format formatFilter,
java.util.List<java.lang.Long> linkIdFilter,
java.lang.String linkUrlFilter,
java.util.List<java.lang.String> linkTagFilter,
java.util.List<java.lang.String> socialNetworkFilter,
java.util.List<java.lang.String> deviceTypeFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousClicks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of clicks.
|
int |
getClicksCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeAnonymousClicks)
Returns the number of clicks.
|
int |
getClicksCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
Format formatFilter,
java.util.List<java.lang.Long> linkIdFilter,
java.lang.String linkUrlFilter,
java.util.List<java.lang.String> linkTagFilter,
java.util.List<java.lang.String> socialNetworkFilter,
java.util.List<java.lang.String> deviceTypeFilter,
boolean excludeAnonymousClicks)
Returns the number of clicks.
|
Page<Open> |
getOpens(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousOpens,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of opens.
|
Page<Open> |
getOpens(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
Format formatFilter,
java.util.List<java.lang.String> socialNetworkFilter,
java.util.List<java.lang.String> deviceTypeFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousOpens,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of opens.
|
int |
getOpensCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeAnonymousOpens)
Returns the number of opens.
|
int |
getOpensCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
Format formatFilter,
java.util.List<java.lang.String> socialNetworkFilter,
java.util.List<java.lang.String> deviceTypeFilter,
boolean excludeAnonymousOpens)
Returns the number of opens.
|
Page<Recipient> |
getRecipients(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeDeletedRecipients,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of contacts that received at least one mailing.
|
Page<Recipient> |
getRecipients(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean excludeDeletedRecipients,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of contacts that received at least one mailing.
|
int |
getRecipientsCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeDeletedRecipients)
Returns the number of recipients.
|
int |
getRecipientsCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean excludeDeletedRecipients)
Returns the number of recipients.
|
Page<Subscriber> |
getSubscribers(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean excludeAnonymousClicks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of contacts that subscribed for the given account.
|
Page<Click> |
getUniqueClicks(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousClicks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of unique clicks.
|
Page<Click> |
getUniqueClicks(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousClicks,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of unique clicks.
|
int |
getUniqueClicksCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeAnonymousClicks)
Returns the number of unique clicks.
|
int |
getUniqueClicksCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean excludeAnonymousClicks)
Returns the number of unique clicks.
|
Page<Open> |
getUniqueOpens(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousOpens,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
int pageIndex,
int pageSize)
Returns a page of unique opens.
|
Page<Open> |
getUniqueOpens(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
boolean embedEmailClientInfos,
boolean excludeAnonymousOpens,
java.util.List<StandardContactField> standardFields,
java.util.List<java.lang.String> customFields,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of unique opens.
|
int |
getUniqueOpensCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
boolean excludeAnonymousOpens)
Returns the number of unique opens.
|
int |
getUniqueOpensCount(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
Format formatFilter,
java.util.List<java.lang.String> socialNetworkFilter,
java.util.List<java.lang.String> deviceTypeFilter,
boolean excludeAnonymousOpens)
Returns the number of unique opens.
|
Page<Unsubscriber> |
getUnsubscribers(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
int pageIndex,
int pageSize)
Returns a page of unsubscribers.
|
Page<Unsubscriber> |
getUnsubscribers(java.lang.Long fromDate,
java.lang.Long toDate,
java.util.List<java.lang.Long> mailingIdFilter,
java.util.List<java.lang.Long> contactIDsFilter,
java.util.List<java.lang.String> contactEmailsFilter,
java.util.List<java.lang.String> contactExternalIDsFilter,
java.lang.String sourceFilter,
boolean embedFieldBackups,
int pageIndex,
int pageSize)
Returns a page of unsubscribers.
|
delete, delete, delete, encodePath, get, get, get, isCompressionEnabled, isDebug, isRequestCompressionEnabled, post, post, post, put, put, put, setCompressionEnabled, setDebug, setRequestCompressionEnabled
public static final java.lang.String SERVICE
public MaileonReportsService(MaileonConfiguration config)
config
- the configuration of maileon APIpublic Page<Open> getOpens(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean embedEmailClientInfos, boolean excludeAnonymousOpens, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingsembedEmailClientInfos
- ff the set to true
, available email client details will be appended to each openexcludeAnonymousOpens
- if true
, the opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public Page<Open> getOpens(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, Format formatFilter, java.util.List<java.lang.String> socialNetworkFilter, java.util.List<java.lang.String> deviceTypeFilter, boolean embedEmailClientInfos, boolean excludeAnonymousOpens, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsformatFilter
- filters the opens by format. Possible values are: html / text.socialNetworkFilter
- multivalued parameter to filter the opens by the social networks where they occurreddeviceTypeFilter
- multivalued parameter to filter the opens by device type. Possible values are: UNKNOWN / COMPUTER / TABLET / MOBILE
.embedEmailClientInfos
- ff the set to true
, available email client details will be appended to each openexcludeAnonymousOpens
- if true
, the opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public Page<Open> getUniqueOpens(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean embedEmailClientInfos, boolean excludeAnonymousOpens, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unique opens after the given date will be returnedtoDate
- if provided, only the unique opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique opens by mailingsembedEmailClientInfos
- ff the set to true
, available email client details will be appended to each unique openexcludeAnonymousOpens
- if true
, the unique opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public Page<Open> getUniqueOpens(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean embedEmailClientInfos, boolean excludeAnonymousOpens, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unique opens after the given date will be returnedtoDate
- if provided, only the unique opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external ids UNKNOWN / COMPUTER / TABLET / MOBILE
.embedEmailClientInfos
- ff the set to true
, available email client details will be appended to each unique openexcludeAnonymousOpens
- if true
, the unique opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public int getOpensCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeAnonymousOpens) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingsexcludeAnonymousOpens
- if true
, the opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsMaileonException
public int getOpensCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, Format formatFilter, java.util.List<java.lang.String> socialNetworkFilter, java.util.List<java.lang.String> deviceTypeFilter, boolean excludeAnonymousOpens) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsformatFilter
- filters the opens by format. Possible values are: html / text.socialNetworkFilter
- multivalued parameter to filter the opens by the social networks where they occurreddeviceTypeFilter
- multivalued parameter to filter the opens by device type. Possible values are: UNKNOWN / COMPUTER / TABLET / MOBILE
.excludeAnonymousOpens
- if true
, the opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsMaileonException
public int getUniqueOpensCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeAnonymousOpens) throws MaileonException
fromDate
- if provided, only the unique opens after the given date will be returnedtoDate
- if provided, only the unique opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique opens by mailingsexcludeAnonymousOpens
- if true
, the unique opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsMaileonException
public int getUniqueOpensCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, Format formatFilter, java.util.List<java.lang.String> socialNetworkFilter, java.util.List<java.lang.String> deviceTypeFilter, boolean excludeAnonymousOpens) throws MaileonException
fromDate
- if provided, only the unique opens after the given date will be returnedtoDate
- if provided, only the unique opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsformatFilter
- filters the unique opens by format. Possible values are: html / text.socialNetworkFilter
- multivalued parameter to filter the unique opens by the social networks where they occurreddeviceTypeFilter
- multivalued parameter to filter the unique opens by device type. Possible values are: UNKNOWN / COMPUTER / TABLET / MOBILE
.excludeAnonymousOpens
- if true
, the unique opens that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsMaileonException
public Page<Recipient> getRecipients(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeDeletedRecipients, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingsexcludeDeletedRecipients
- if true
, the recipients that have been removed from maileon will be excludedstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public Page<Recipient> getRecipients(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean excludeDeletedRecipients, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsexcludeDeletedRecipients
- if true
, the recipients that have been removed from maileon will be excludedstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Open
in the resulted pageMaileonException
public int getRecipientsCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeDeletedRecipients) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingsexcludeDeletedRecipients
- if true
, the recipients that have been removed from maileon will be excludedMaileonException
public int getRecipientsCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean excludeDeletedRecipients) throws MaileonException
fromDate
- if provided, only the opens after the given date will be returnedtoDate
- if provided, only the opens before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the opens by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsexcludeDeletedRecipients
- if true
, the recipients that have been removed from maileon will be excludedMaileonException
public Page<Click> getClicks(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean embedEmailClientInfos, boolean excludeAnonymousClicks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the clicks after the given date will be returnedtoDate
- if provided, only the clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the clicks by mailingsembedEmailClientInfos
- ff the set to true
, available email client details will be appended to each clickexcludeAnonymousClicks
- if true
, the clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Click
in the resulted pageMaileonException
public Page<Click> getClicks(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, Format formatFilter, java.util.List<java.lang.Long> linkIdFilter, java.lang.String linkUrlFilter, java.util.List<java.lang.String> linkTagFilter, java.util.List<java.lang.String> socialNetworkFilter, java.util.List<java.lang.String> deviceTypeFilter, boolean embedEmailClientInfos, boolean excludeAnonymousClicks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the clicks after the given date will be returnedtoDate
- if provided, only the clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the clicks by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsformatFilter
- filters the clicks by format. Possible values are: html / text.linkIdFilter
- multivalued parameter to filter the clicks by linkslinkUrlFilter
- filters the clicks by link urllinkTagFilter
- multivalued parameter to filter the clicks by tags associated to the linkssocialNetworkFilter
- multivalued parameter to filter the clicks by the social networks where they occurreddeviceTypeFilter
- multivalued parameter to filter the clicks by device type. Possible values are: UNKNOWN / COMPUTER / TABLET / MOBILE
.embedEmailClientInfos
- ff the set to true
, available email client details will be appended to each clickexcludeAnonymousClicks
- if true
, the clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Click
in the resulted pageMaileonException
public Page<Click> getUniqueClicks(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean embedEmailClientInfos, boolean excludeAnonymousClicks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unique clicks after the given date will be returnedtoDate
- if provided, only the unique clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique clicks by mailingsembedEmailClientInfos
- ff the set to true
, available email client details will be appended to each unique clickexcludeAnonymousClicks
- if true
, the unique clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Click
in the resulted pageMaileonException
public Page<Click> getUniqueClicks(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean embedEmailClientInfos, boolean excludeAnonymousClicks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unique clicks after the given date will be returnedtoDate
- if provided, only the unique clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique clicks by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsembedEmailClientInfos
- ff the set to true
, available email client details will be appended to each unique clickexcludeAnonymousClicks
- if true
, the unique clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Click
in the resulted pageMaileonException
public int getClicksCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeAnonymousClicks) throws MaileonException
fromDate
- if provided, only the clicks after the given date will be returnedtoDate
- if provided, only the clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the clicks by mailingsexcludeAnonymousClicks
- if true
, the clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsMaileonException
public int getClicksCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, Format formatFilter, java.util.List<java.lang.Long> linkIdFilter, java.lang.String linkUrlFilter, java.util.List<java.lang.String> linkTagFilter, java.util.List<java.lang.String> socialNetworkFilter, java.util.List<java.lang.String> deviceTypeFilter, boolean excludeAnonymousClicks) throws MaileonException
fromDate
- if provided, only the clicks after the given date will be returnedtoDate
- if provided, only the clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the clicks by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsformatFilter
- filters the clicks by format. Possible values are: html / text.linkIdFilter
- multivalued parameter to filter the clicks by linkslinkUrlFilter
- filters the clicks by link urllinkTagFilter
- multivalued parameter to filter the clicks by tags associated to the linkssocialNetworkFilter
- multivalued parameter to filter the clicks by the social networks where they occurreddeviceTypeFilter
- multivalued parameter to filter the clicks by device type. Possible values are: UNKNOWN / COMPUTER / TABLET / MOBILE
.excludeAnonymousClicks
- if true
, the clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
resultsMaileonException
public int getUniqueClicksCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeAnonymousClicks) throws MaileonException
fromDate
- if provided, only the unique clicks after the given date will be returnedtoDate
- if provided, only the unique clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique clicks by mailingsexcludeAnonymousClicks
- if true
, the unique clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsMaileonException
public int getUniqueClicksCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean excludeAnonymousClicks) throws MaileonException
fromDate
- if provided, only the unique clicks after the given date will be returnedtoDate
- if provided, only the unique clicks before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unique clicks by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsexcludeAnonymousClicks
- if true
, the unique clicks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsMaileonException
public Page<Bounce> getBounces(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, boolean excludeAnonymousBounces, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the bounces after the given date will be returnedtoDate
- if provided, only the bounces before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the bounces by mailingsexcludeAnonymousBounces
- if true
, the bounces that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Bounce
in the resulted pageMaileonException
public Page<Bounce> getBounces(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, java.util.List<java.lang.String> statusCodeFilter, java.lang.String typeFilter, java.lang.String sourceFilter, boolean excludeAnonymousBounces, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the bounces after the given date will be returnedtoDate
- if provided, only the bounces before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the bounces by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsstatusCodeFilter
- filters the bounces by status codes. Status codes follow the pattern digit.digit.digit (e.g. 5.0.0)typeFilter
- filters the bounces by type: permanent / transientsourceFilter
- filters the bounces by their source: mta-listener / replyexcludeAnonymousBounces
- if true
, the bounces that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the
resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Bounce
in the resulted pageMaileonException
public Page<Unsubscriber> getUnsubscribers(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unsubscribers after the given date will be returnedtoDate
- if provided, only the unsubscribers before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unsubscribers by mailingspageIndex
- the index of the result page starting from 1pageSize
- the number of Unsubscriber
in the resulted pageMaileonException
public Page<Unsubscriber> getUnsubscribers(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, java.lang.String sourceFilter, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the unsubscribers after the given date will be returnedtoDate
- if provided, only the unsubscribers before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the unsubscribers by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idssourceFilter
- filters the unsubscriptions by their source. The source can be an unsubscription link (link), a reply mail (reply) or other.embedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Unsubscriber
in the resulted pageMaileonException
public Page<Subscriber> getSubscribers(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> mailingIdFilter, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, boolean excludeAnonymousClicks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, boolean embedFieldBackups, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the subscribers after the given date will be returnedtoDate
- if provided, only the subscribers before the given date will be returnedmailingIdFilter
- multivalued parameter to filter the subscribers by mailingscontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsexcludeAnonymousClicks
- if true
, the subscribers that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted
in the resultsstandardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldembedFieldBackups
- if true
, the corresponding field backups will be returned if availablepageIndex
- the index of the result page starting from 1pageSize
- the number of Subscriber
in the resulted pageMaileonException
public Page<Block> getBlocks(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, java.util.List<java.lang.String> reasons, java.lang.String oldStatus, java.lang.String newStatus, boolean excludeAnonymousBlocks, java.util.List<StandardContactField> standardFields, java.util.List<java.lang.String> customFields, int pageIndex, int pageSize) throws MaileonException
fromDate
- if provided, only the blocks after the given date will be returnedtoDate
- if provided, only the blocks before the given date will be returnedcontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsreasons
- multivalued parameter to filter the blocks by reasons. Possible values are: blacklist
and bounce_policy
.oldStatus
- filter by old status, valid: allowed, blockednewStatus
- Filter by new status, valid: allowed, blockedexcludeAnonymousBlocks
- if true
, the blocks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
results.standardFields
- multivalued parameter to query the value of a standard contact fieldcustomFields
- multivalued parameter to query the value of a custom contact fieldpageIndex
- the index of the result page starting from 1pageSize
- the number of Block
in the resulted pageMaileonException
public int getBlocksCount(java.lang.Long fromDate, java.lang.Long toDate, java.util.List<java.lang.Long> contactIDsFilter, java.util.List<java.lang.String> contactEmailsFilter, java.util.List<java.lang.String> contactExternalIDsFilter, java.util.List<java.lang.String> reasons, java.lang.String oldStatus, java.lang.String newStatus, boolean excludeAnonymousBlocks) throws MaileonException
fromDate
- if provided, only the blocks after the given date will be returnedtoDate
- if provided, only the blocks before the given date will be returnedcontactIDsFilter
- multivalued parameter to filter the results by contactscontactEmailsFilter
- multivalued parameter to filter the results by email addressescontactExternalIDsFilter
- multivalued parameter to filter the results by external idsreasons
- multivalued parameter to filter the blocks by reasons. Possible values are: blacklist
and bounce_policy
.oldStatus
- filter by old status, valid: allowed, blockednewStatus
- Filter by new status, valid: allowed, blockedexcludeAnonymousBlocks
- if true
, the blocks that cannot be mapped to contacts because of permission types or because of unsubscriptions are omitted in the
results.MaileonException
Copyright © 2017. All Rights Reserved.