Inheritance diagram for com_maileon_api_reports_ReportsService:

Public Member Functions
	getOpens ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $formatFilter=null, $socialNetworkFilter=null, $deviceTypeFilter=null, $embedEmailClientInfos=false, $excludeAnonymousOpens=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getUniqueOpens ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $embedEmailClientInfos=false, $excludeAnonymousOpens=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getOpensCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $formatFilter=null, $socialNetworkFilter=null, $deviceTypeFilter=null, $excludeAnonymousOpens=false)

	getUniqueOpensCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousOpens=false)

	getRecipients ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeDeletedRecipients=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getRecipientsCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeDeletedRecipients=false)

	getClicks ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $formatFilter=null, $linkIdFilter=null, $linkUrlFilter=null, $linkTagFilter=null, $socialNetworkFilter=null, $deviceTypeFilter=null, $embedEmailClientInfos=false, $excludeAnonymousClicks=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100, $embedLinkTags=false)

	getUniqueClicks ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $embedEmailClientInfos=false, $excludeAnonymousClicks=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100, $embedLinkTags=false)

	getClicksCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $formatFilter=null, $linkIdFilter=null, $linkUrlFilter=null, $linkTagFilter=null, $socialNetworkFilter=null, $deviceTypeFilter=null, $excludeAnonymousClicks=false)

	getUniqueClicksCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousClicks=false)

	getBounces ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $statusCodeFilter=null, $typeFilter=null, $sourceFilter=null, $excludeAnonymousBounces=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getUniqueBounces ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousBounces=false, $standardFields=null, $customFields=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getBouncesCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $statusCodeFilter=null, $typeFilter=null, $sourceFilter=null, $excludeAnonymousBounces=false)

	getUniqueBouncesCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousBounces=false)

	getBlocks ($fromDate=null, $toDate=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $reasons=null, $oldStatus=null, $newStatus=null, $excludeAnonymousBlocks=false, $standardFields=null, $customFields=null, $pageIndex=1, $pageSize=100)

	getBlocksCount ($fromDate=null, $toDate=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $reasons=null, $oldStatus=null, $newStatus=null, $excludeAnonymousBlocks=false)

	getUnsubscribers ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $source=null, $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getUnsubscribersCount ($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $source=null)

	getSubscribers ($fromDate=null, $toDate=null, $mailingIds=array(), $contactIds=array(), $contactEmails=array(), $contactExternalIds=array(), $excludeAnonymousContacts=false, $standardFields=array(), $customFields=array(), $embedFieldBackups=false, $pageIndex=1, $pageSize=100)

	getSubscribersCount ($fromDate=null, $toDate=null, $mailingIds=array(), $contactIds=array(), $contactEmails=array(), $contactExternalIds=array(), $excludeAnonymousContacts=false)

Public Member Functions inherited from com_maileon_api_AbstractMaileonService
	__construct (array $config)

	setDebug ($isDebug)

	isDebug ()

	get ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)

	put ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)

	post ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null, $contentType=null, $contentLength=null)

	delete ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null)

Additional Inherited Members
Static Public Attributes inherited from com_maileon_api_AbstractMaileonService
static	$MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml'

Protected Member Functions inherited from com_maileon_api_AbstractMaileonService
	appendArrayFields ($params, $name, $fieldValues)

Protected Attributes inherited from com_maileon_api_AbstractMaileonService
	$configuration

	$encodedApiKey

	$debug = false

	$throwException = true

	$proxy_host

	$proxy_port = 80

	$timeout

Detailed Description

Author: Viktor Balogh (Wiera); Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com

Definition at line 9 of file ReportsService.php.

Member Function Documentation

com_maileon_api_reports_ReportsService::getOpens	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$formatFilter = `null`,
		$socialNetworkFilter = `null`,
		$deviceTypeFilter = `null`,
		$embedEmailClientInfos = `false`,
		$excludeAnonymousOpens = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of openers.

Parameters

long	$fromDate	If provided, only the openers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the openers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the openers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the openers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the openers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the openers by external ids. Each value must correspond to a contacts external id.
string	$formatFilter	Filters the opens by format. Possible values are: html / text.
array	$socialNetworkFilter	Multivalued parameter to filter the opens by the social networks where they occurred.
array	$deviceTypeFilter	Multivalued parameter to filter the opens by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE
bool	$embedEmailClientInfos	If the set to true, available email client details will be appended to each open.
bool	$excludeAnonymousOpens	If this is set to true (default), only openers that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 49 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueOpens	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$embedEmailClientInfos = `false`,
		$excludeAnonymousOpens = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of unique openers.

Parameters

long	$fromDate	If provided, only the openers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the openers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the openers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the openers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the openers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the openers by external ids. Each value must correspond to a contacts external id.
bool	$embedEmailClientInfos	If the set to true, available email client details will be appended to each open.
bool	$excludeAnonymousOpens	If this is set to true (default), only openers that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 113 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getOpensCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$formatFilter = `null`,
		$socialNetworkFilter = `null`,
		$deviceTypeFilter = `null`,
		$excludeAnonymousOpens = `false`
	)

Count openers.

Parameters

long	$fromDate	If provided, only the openers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the openers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the openers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the openers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the openers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the openers by external ids. Each value must correspond to a contacts external id.
string	$formatFilter	Filters the opens by format. Possible values are: html / text.
array	$socialNetworkFilter	Multivalued parameter to filter the opens by the social networks where they occurred.
array	$deviceTypeFilter	Multivalued parameter to filter the opens by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE
bool	$excludeAnonymousOpens	If this is set to true (default), only openers that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 164 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueOpensCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeAnonymousOpens = `false`
	)

Count unique openers.

Parameters

long	$fromDate	If provided, only the openers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the openers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the openers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the openers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the openers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the openers by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousOpens	If this is set to true (default), only openers that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 207 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getRecipients	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeDeletedRecipients = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of recipients.

Parameters

long	$fromDate	If provided, only the recipients after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the recipients before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the recipients by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the recipients by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the recipients by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the recipients by external ids. Each value must correspond to a contacts external id.
bool	$excludeDeletedRecipients	Supported values: true / false. If set to true, the recipients that have been removed from maileon will be excluded.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 253 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getRecipientsCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeDeletedRecipients = `false`
	)

Count recipients.

Parameters

long	$fromDate	If provided, only the recipients after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the recipients before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the recipients by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the recipients by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the recipients by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the recipients by external ids. Each value must correspond to a contacts external id.
bool	$excludeDeletedRecipients	Supported values: true / false. If set to true, the recipients that have been removed from maileon will be excluded.

Returns: com_maileon_api_Page

Definition at line 296 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getClicks	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$formatFilter = `null`,
		$linkIdFilter = `null`,
		$linkUrlFilter = `null`,
		$linkTagFilter = `null`,
		$socialNetworkFilter = `null`,
		$deviceTypeFilter = `null`,
		$embedEmailClientInfos = `false`,
		$excludeAnonymousClicks = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`,
		$embedLinkTags = `false`
	)

Returns a page of clickers.

Parameters

long	$fromDate	If provided, only the clickers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the clickers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the clickers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the clickers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the clickers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the clickers by external ids. Each value must correspond to a contacts external id.
string	$formatFilter	Filters the opens by format. Possible values are: html / text.
array	$linkIdFilter	Multivalued parameter to filter the clicks by links. Each value must correspond to a link id.
string	$linkUrlFilter	Filters the clicks by link url.
array	$linkTagFilter	Multivalued parameter to filter the clicks by tags associated to the links.
array	$socialNetworkFilter	Multivalued parameter to filter the opens by the social networks where they occurred.
array	$deviceTypeFilter	Multivalued parameter to filter the opens by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE
bool	$embedEmailClientInfos	If the set to true, available email client details will be appended to each open.
bool	$excludeAnonymousClicks	If this is set to true (default), only clicks that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
bool	$embedLinkTags	If the set to true, available link tags will be appended to each click.

Returns: com_maileon_api_Page

Definition at line 359 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueClicks	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$embedEmailClientInfos = `false`,
		$excludeAnonymousClicks = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`,
		$embedLinkTags = `false`
	)

Returns a page of unique clickers.

Parameters

long	$fromDate	If provided, only the clickers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the clickers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the clickers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the clickers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the clickers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the clickers by external ids. Each value must correspond to a contacts external id.
bool	$embedEmailClientInfos	If the set to true, available email client details will be appended to each open.
bool	$excludeAnonymousClicks	If this is set to true (default), only clicks that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
bool	$embedLinkTags	If the set to true, available link tags will be appended to each click.

Returns: com_maileon_api_Page

Definition at line 433 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getClicksCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$formatFilter = `null`,
		$linkIdFilter = `null`,
		$linkUrlFilter = `null`,
		$linkTagFilter = `null`,
		$socialNetworkFilter = `null`,
		$deviceTypeFilter = `null`,
		$excludeAnonymousClicks = `false`
	)

Count clickers.

Parameters

long	$fromDate	If provided, only the clickers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the clickers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the clickers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the clickers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the clickers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the clickers by external ids. Each value must correspond to a contacts external id.
string	$formatFilter	Filters the opens by format. Possible values are: html / text.
array	$linkIdFilter	Multivalued parameter to filter the clicks by links. Each value must correspond to a link id.
string	$linkUrlFilter	Filters the clicks by link url.
array	$linkTagFilter	Multivalued parameter to filter the clicks by tags associated to the links.
array	$socialNetworkFilter	Multivalued parameter to filter the opens by the social networks where they occurred.
array	$deviceTypeFilter	Multivalued parameter to filter the opens by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE
bool	$excludeAnonymousClicks	If this is set to true (default), only clicks that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 493 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueClicksCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeAnonymousClicks = `false`
	)

Count unique clickers.

Parameters

long	$fromDate	If provided, only the clickers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the clickers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the clickers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the clickers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the clickers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the clickers by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousClicks	If this is set to true (default), only clicks that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 542 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getBounces	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$statusCodeFilter = `null`,
		$typeFilter = `null`,
		$sourceFilter = `null`,
		$excludeAnonymousBounces = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of bouncers.

Parameters

long	$fromDate	If provided, only the bouncers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the bouncers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the bouncers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the bouncers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the bouncers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the bouncers by external ids. Each value must correspond to a contacts external id.
array	$statusCodeFilter	Filters the bounces by status codes. Status codes follow the pattern digit.digit.digit (example: 5.0.0).
string	$typeFilter	Filters the bounces by type: permanent / transient.
string	$sourceFilter	Filters the bounces by their source: mta-listener / reply.
bool	$excludeAnonymousBounces	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 595 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueBounces	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeAnonymousBounces = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of unique bouncers.

Parameters

long	$fromDate	If provided, only the bouncers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the bouncers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the bouncers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the bouncers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the bouncers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the bouncers by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousBounces	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 655 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getBouncesCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$statusCodeFilter = `null`,
		$typeFilter = `null`,
		$sourceFilter = `null`,
		$excludeAnonymousBounces = `false`
	)

Count bouncers.

Parameters

long	$fromDate	If provided, only the bouncers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the bouncers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the bouncers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the bouncers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the bouncers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the bouncers by external ids. Each value must correspond to a contacts external id.
array	$statusCodeFilter	Filters the bounces by status codes. Status codes follow the pattern digit.digit.digit (example: 5.0.0).
string	$typeFilter	Filters the bounces by type: permanent / transient.
string	$sourceFilter	Filters the bounces by their source: mta-listener / reply.
bool	$excludeAnonymousBounces	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 705 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUniqueBouncesCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$excludeAnonymousBounces = `false`
	)

Count unique bouncers.

Parameters

long	$fromDate	If provided, only the bouncers after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the bouncers before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the bouncers by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the bouncers by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the bouncers by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the bouncers by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousBounces	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 747 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getBlocks	(	$fromDate = `null`,
		$toDate = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$reasons = `null`,
		$oldStatus = `null`,
		$newStatus = `null`,
		$excludeAnonymousBlocks = `false`,
		$standardFields = `null`,
		$customFields = `null`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of blocks.

Parameters

long	$fromDate	If provided, only the blocks after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the blocks before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$contactIds	Multivalued parameter to filter the blocks by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the blocks by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the blocks by external ids. Each value must correspond to a contacts external id.
array	$reasons	Filter by reason, valid: blacklist, bounce_policy.
string	$oldStatus	Filter by old status, valid: allowed, blocked.
string	$newStatus	Filter by new status, valid: allowed, blocked.
bool	$excludeAnonymousBlocks	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 795 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getBlocksCount	(	$fromDate = `null`,
		$toDate = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$reasons = `null`,
		$oldStatus = `null`,
		$newStatus = `null`,
		$excludeAnonymousBlocks = `false`
	)

Count blocks.

Parameters

long	$fromDate	If provided, only the blocks after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the blocks before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$contactIds	Multivalued parameter to filter the blocks by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the blocks by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the blocks by external ids. Each value must correspond to a contacts external id.
array	$reasons	Filter by reason, valid: blacklist, bounce_policy.
string	$oldStatus	Filter by old status, valid: allowed, blocked.
string	$newStatus	Filter by new status, valid: allowed, blocked. Filters the bounces by their source: mta-listener / reply.
bool	$excludeAnonymousBlocks	If this is set to true (default), only bounces that have not yet been anonymized (due to deletion/unsubscription) are returned.

Returns: com_maileon_api_Page

Definition at line 849 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUnsubscribers	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$source = `null`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of unsubscriberss.

Parameters

long	$fromDate	If provided, only the unsubscriptions after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the unsubscriptions before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the unsubscriptions by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the unsubscriptions by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the unsubscriptions by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the unsubscriptions by external ids. Each value must correspond to a contacts external id.
string	$source	Filters the unsubscriptions by their source. The source can be an unsubscription link (link), a reply mail (reply) or other.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 898 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getUnsubscribersCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `null`,
		$contactIds = `null`,
		$contactEmails = `null`,
		$contactExternalIds = `null`,
		$source = `null`
	)

Count unsubscribers.

Parameters

long	$fromDate	If provided, only the unsubscriptions after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the unsubscriptions before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the unsubscriptions by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the unsubscriptions by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the unsubscriptions by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the unsubscriptions by external ids. Each value must correspond to a contacts external id.
string	$source	Filters the unsubscriptions by their source. The source can be an unsubscription link (link), a reply mail (reply) or other.

Returns: com_maileon_api_Page

Definition at line 935 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getSubscribers	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `array()`,
		$contactIds = `array()`,
		$contactEmails = `array()`,
		$contactExternalIds = `array()`,
		$excludeAnonymousContacts = `false`,
		$standardFields = `array()`,
		$customFields = `array()`,
		$embedFieldBackups = `false`,
		$pageIndex = `1`,
		$pageSize = `100`
	)

Returns a page of subscribers.

Parameters

long	$fromDate	If provided, only the unsubscriptions after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the unsubscriptions before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the unsubscriptions by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the unsubscriptions by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the unsubscriptions by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the unsubscriptions by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousContacts	If this is set to true (default), only subscribers that have not yet been anonymized (due to deletion) are returned.
bool	$standardFields	The list of standard contact fields to return.
bool	$customFields	The list of custom contact fields to return.
bool	$embedFieldBackups	Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each unsubscription, the corresponding field backups will be returned if available. Note that this only applies for non anonymizable field backups.
integer	$pageIndex	The index of the result page. The index must be greater or equal to 1.
integer	$pageSize	The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Returns: com_maileon_api_Page

Definition at line 978 of file ReportsService.php.

com_maileon_api_reports_ReportsService::getSubscribersCount	(	$fromDate = `null`,
		$toDate = `null`,
		$mailingIds = `array()`,
		$contactIds = `array()`,
		$contactEmails = `array()`,
		$contactExternalIds = `array()`,
		$excludeAnonymousContacts = `false`
	)

Count subscribers.

Parameters

long	$fromDate	If provided, only the unsubscriptions after the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
long	$toDate	If provided, only the unsubscriptions before the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
array	$mailingIds	Multivalued parameter to filter the unsubscriptions by mailings. Each value must correspond to a mailing id.
array	$contactIds	Multivalued parameter to filter the unsubscriptions by contacts. Each value must correspond to a contact id.
array	$contactEmails	Multivalued parameter to filter the unsubscriptions by email addresses.
array	$contactExternalIds	Multivalued parameter to filter the unsubscriptions by external ids. Each value must correspond to a contacts external id.
bool	$excludeAnonymousContacts	If this is set to true (default), only subscribers that have not yet been anonymized (due to deletion) are returned.

Returns: com_maileon_api_Page

Definition at line 1009 of file ReportsService.php.

The documentation for this class was generated from the following file:

client/com/maileon/api/reports/ReportsService.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation