54 $contactEmails = null,
55 $contactExternalIds = null,
57 $socialNetworkFilter = null,
58 $deviceTypeFilter = null,
59 $embedEmailClientInfos =
false,
60 $excludeAnonymousOpens =
false,
61 $standardFields = null,
63 $embedFieldBackups =
false,
68 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
70 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
71 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
72 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
73 if (isset($excludeAnonymousOpens)) $params[
'exclude_anonymous_opens'] = ($excludeAnonymousOpens ==
true) ?
"true" :
"false";
75 if (isset($formatFilter)) $params[
'format'] = $formatFilter;
76 $params = $this->appendArrayFields($params,
"social_network", $socialNetworkFilter);
77 $params = $this->appendArrayFields($params,
"device_type", $deviceTypeFilter);
79 return $this->
get(
'reports/opens', $params);
118 $contactEmails = null,
119 $contactExternalIds = null,
120 $embedEmailClientInfos =
false,
121 $excludeAnonymousOpens =
false,
122 $standardFields = null,
123 $customFields = null,
124 $embedFieldBackups =
false,
129 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
131 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
132 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
133 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
134 if (isset($excludeAnonymousOpens)) $params[
'exclude_anonymous_opens'] = ($excludeAnonymousOpens ==
true) ?
"true" :
"false";
136 return $this->
get(
'reports/opens/unique', $params);
169 $contactEmails = null,
170 $contactExternalIds = null,
171 $formatFilter = null,
172 $socialNetworkFilter = null,
173 $deviceTypeFilter = null,
174 $excludeAnonymousOpens =
false)
177 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
179 if (isset($excludeAnonymousOpens)) $params[
'exclude_anonymous_opens'] = ($excludeAnonymousOpens ==
true) ?
"true" :
"false";
181 if (isset($formatFilter)) $params[
'format'] = $formatFilter;
182 $params = $this->appendArrayFields($params,
"social_network", $socialNetworkFilter);
183 $params = $this->appendArrayFields($params,
"device_type", $deviceTypeFilter);
185 return $this->
get(
'reports/opens/count', $params);
212 $contactEmails = null,
213 $contactExternalIds = null,
214 $excludeAnonymousOpens =
false)
217 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
219 if (isset($excludeAnonymousOpens)) $params[
'exclude_anonymous_opens'] = ($excludeAnonymousOpens ==
true) ?
"true" :
"false";
221 return $this->
get(
'reports/opens/unique/count', $params);
258 $contactEmails = null,
259 $contactExternalIds = null,
260 $excludeDeletedRecipients =
false,
261 $standardFields = null,
262 $customFields = null,
263 $embedFieldBackups =
false,
268 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
270 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
271 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
272 if (isset($excludeDeletedRecipients)) $params[
'exclude_deleted_recipients'] = ($excludeDeletedRecipients ==
true) ?
"true" :
"false";
274 return $this->
get(
'reports/recipients', $params);
301 $contactEmails = null,
302 $contactExternalIds = null,
303 $excludeDeletedRecipients =
false)
306 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
308 if (isset($excludeDeletedRecipients)) $params[
'exclude_deleted_recipients'] = ($excludeDeletedRecipients ==
true) ?
"true" :
"false";
310 return $this->
get(
'reports/recipients/count', $params);
364 $contactEmails = null,
365 $contactExternalIds = null,
366 $formatFilter = null,
367 $linkIdFilter = null,
368 $linkUrlFilter = null,
369 $linkTagFilter = null,
370 $socialNetworkFilter = null,
371 $deviceTypeFilter = null,
372 $embedEmailClientInfos =
false,
373 $excludeAnonymousClicks =
false,
374 $standardFields = null,
375 $customFields = null,
376 $embedFieldBackups =
false,
379 $embedLinkTags =
false)
382 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
384 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
385 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
386 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
387 if (isset($embedLinkTags)) $params[
'embed_link_tags'] = ($embedLinkTags ==
true) ?
"true" :
"false";
388 if (isset($excludeAnonymousClicks)) $params[
'exclude_anonymous_clicks'] = ($excludeAnonymousClicks ==
true) ?
"true" :
"false";
390 if (isset($formatFilter)) $params[
'format'] = $formatFilter;
391 $params = $this->appendArrayFields($params,
"link_id", $linkIdFilter);
392 if (isset($linkUrlFilter)) $params[
'link_url'] = $linkUrlFilter;
393 $params = $this->appendArrayFields($params,
"link_tag", $linkTagFilter);
394 $params = $this->appendArrayFields($params,
"social_network", $socialNetworkFilter);
395 $params = $this->appendArrayFields($params,
"device_type", $deviceTypeFilter);
397 return $this->
get(
'reports/clicks', $params);
438 $contactEmails = null,
439 $contactExternalIds = null,
440 $embedEmailClientInfos =
false,
441 $excludeAnonymousClicks =
false,
442 $standardFields = null,
443 $customFields = null,
444 $embedFieldBackups =
false,
447 $embedLinkTags =
false)
450 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
452 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
453 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
454 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
455 if (isset($embedLinkTags)) $params[
'embed_link_tags'] = ($embedLinkTags ==
true) ?
"true" :
"false";
456 if (isset($excludeAnonymousClicks)) $params[
'exclude_anonymous_clicks'] = ($excludeAnonymousClicks ==
true) ?
"true" :
"false";
458 return $this->
get(
'reports/clicks/unique', $params);
498 $contactEmails = null,
499 $contactExternalIds = null,
500 $formatFilter = null,
501 $linkIdFilter = null,
502 $linkUrlFilter = null,
503 $linkTagFilter = null,
504 $socialNetworkFilter = null,
505 $deviceTypeFilter = null,
506 $excludeAnonymousClicks =
false)
509 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
511 if (isset($excludeAnonymousClicks)) $params[
'exclude_anonymous_clicks'] = ($excludeAnonymousClicks ==
true) ?
"true" :
"false";
513 if (isset($formatFilter)) $params[
'format'] = $formatFilter;
514 $params = $this->appendArrayFields($params,
"link_id", $linkIdFilter);
515 if (isset($linkUrlFilter)) $params[
'link_url'] = $linkUrlFilter;
516 $params = $this->appendArrayFields($params,
"link_tag", $linkTagFilter);
517 $params = $this->appendArrayFields($params,
"social_network", $socialNetworkFilter);
518 $params = $this->appendArrayFields($params,
"device_type", $deviceTypeFilter);
520 return $this->
get(
'reports/clicks/count', $params);
547 $contactEmails = null,
548 $contactExternalIds = null,
550 $excludeAnonymousClicks =
false)
553 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
555 if (isset($excludeAnonymousClicks)) $params[
'exclude_anonymous_clicks'] = ($excludeAnonymousClicks ==
true) ?
"true" :
"false";
557 return $this->
get(
'reports/clicks/unique/count', $params);
600 $contactEmails = null,
601 $contactExternalIds = null,
602 $statusCodeFilter = null,
604 $sourceFilter = null,
605 $excludeAnonymousBounces =
false,
606 $standardFields = null,
607 $customFields = null,
608 $embedFieldBackups =
false,
613 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
615 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
616 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
617 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
618 if (isset($excludeAnonymousBounces)) $params[
'exclude_anonymous_bounces'] = ($excludeAnonymousBounces ==
true) ?
"true" :
"false";
620 if (isset($typeFilter)) $params[
'type'] = $typeFilter;
621 if (isset($sourceFilter)) $params[
'source_filter'] = $sourceFilter;
623 return $this->
get(
'reports/bounces', $params);
660 $contactEmails = null,
661 $contactExternalIds = null,
662 $excludeAnonymousBounces =
false,
663 $standardFields = null,
664 $customFields = null,
665 $embedFieldBackups =
false,
670 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
672 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
673 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
674 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
675 if (isset($excludeAnonymousBounces)) $params[
'exclude_anonymous_bounces'] = ($excludeAnonymousBounces ==
true) ?
"true" :
"false";
677 return $this->
get(
'reports/bounces/unique', $params);
710 $contactEmails = null,
711 $contactExternalIds = null,
712 $statusCodeFilter = null,
714 $sourceFilter = null,
715 $excludeAnonymousBounces =
false)
718 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
720 if (isset($excludeAnonymousBounces)) $params[
'exclude_anonymous_bounces'] = ($excludeAnonymousBounces ==
true) ?
"true" :
"false";
722 if (isset($typeFilter)) $params[
'type'] = $typeFilter;
723 if (isset($sourceFilter)) $params[
'source_filter'] = $sourceFilter;
725 return $this->
get(
'reports/bounces/count', $params);
752 $contactEmails = null,
753 $contactExternalIds = null,
754 $excludeAnonymousBounces =
false)
757 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
759 if (isset($excludeAnonymousBounces)) $params[
'exclude_anonymous_bounces'] = ($excludeAnonymousBounces ==
true) ?
"true" :
"false";
761 return $this->
get(
'reports/bounces/unique/count', $params);
799 $contactEmails = null,
800 $contactExternalIds = null,
804 $excludeAnonymousBlocks =
false,
805 $standardFields = null,
806 $customFields = null,
811 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, null, null, null);
813 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
814 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
815 if (isset($embedEmailClientInfos)) $params[
'embed_email_client_infos'] = ($embedEmailClientInfos ==
true) ?
"true" :
"false";
816 if (isset($excludeAnonymousBlocks)) $params[
'exclude_anonymous_blocks'] = ($excludeAnonymousBlocks ==
true) ?
"true" :
"false";
818 $params = $this->appendArrayFields($params,
"reasons", $reasons);
819 if (isset($oldStatus)) $params[
'old_status'] = $oldStatus;
820 if (isset($newStatus)) $params[
'new_status'] = $newStatus;
822 return $this->
get(
'reports/blocks', $params);
853 $contactEmails = null,
854 $contactExternalIds = null,
858 $excludeAnonymousBlocks =
false)
861 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, null, null);
863 if (isset($excludeAnonymousBlocks)) $params[
'exclude_anonymous_blocks'] = ($excludeAnonymousBlocks ==
true) ?
"true" :
"false";
865 $params = $this->appendArrayFields($params,
"reasons", $reasons);
866 if (isset($oldStatus)) $params[
'old_status'] = $oldStatus;
867 if (isset($newStatus)) $params[
'new_status'] = $newStatus;
869 return $this->
get(
'reports/blocks/count', $params);
903 $contactEmails = null,
904 $contactExternalIds = null,
906 $embedFieldBackups =
false,
910 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, $source, $embedFieldBackups);
912 return $this->
get(
'reports/unsubscriptions', $params);
940 $contactEmails = null,
941 $contactExternalIds = null,
944 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, $source);
946 return $this->
get(
'reports/unsubscriptions/count', $params);
978 function 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)
980 $params = $this->createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null, $embedFieldBackups);
982 $params = $this->appendArrayFields($params,
"standard_field", $standardFields);
983 $params = $this->appendArrayFields($params,
"custom_field", $customFields);
984 if (isset ($excludeAnonymousContacts))
985 $params [
'exclude_anonymous_contacts'] = ($excludeAnonymousContacts ==
true) ?
"true" :
"false";
987 return $this->
get(
'reports/subscribers', $params);
1009 function getSubscribersCount($fromDate = null, $toDate = null, $mailingIds = array(), $contactIds = array(), $contactEmails = array(), $contactExternalIds = array(), $excludeAnonymousContacts =
false)
1011 $params = $this->createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, null);
1013 if (isset ($excludeAnonymousContacts))
1014 $params [
'exclude_anonymous_contacts'] = ($excludeAnonymousContacts ==
true) ?
"true" :
"false";
1016 return $this->
get(
'reports/subscribers/count', $params);
1045 private function createQueryParameters($pageIndex, $pageSize, $fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, $source, $embedFieldBackups)
1047 $queryParameters = array(
1048 'page_index' => $pageIndex,
1049 'page_size' => $pageSize
1052 if (isset ($fromDate))
1053 $queryParameters [
'from_date'] = $fromDate;
1054 if (isset ($toDate))
1055 $queryParameters [
'to_date'] = $toDate;
1056 if (isset ($source))
1057 $queryParameters [
'source'] = $source;
1059 $queryParameters = $this->appendArrayFields($queryParameters,
"ids", $contactIds);
1060 $queryParameters = $this->appendArrayFields($queryParameters,
"emails", $contactEmails);
1061 $queryParameters = $this->appendArrayFields($queryParameters,
"eids", $contactExternalIds);
1063 if (isset ($embedFieldBackups))
1064 $queryParameters [
'embed_field_backups'] = ($embedFieldBackups ==
true) ?
"true" :
"false";
1066 if (isset ($mailingIds)) {
1067 $queryParameters [
'mailing_id'] = array();
1069 foreach ($mailingIds as $mailingId) {
1070 $queryParameters [
'mailing_id'] [] = $mailingId;
1073 return $queryParameters;
1096 private function createCountQueryParameters($fromDate, $toDate, $contactIds, $contactEmails, $contactExternalIds, $mailingIds, $source)
1098 $queryParameters = array();
1100 if (isset ($fromDate))
1101 $queryParameters [
'from_date'] = $fromDate;
1102 if (isset ($toDate))
1103 $queryParameters [
'to_date'] = $toDate;
1104 if (isset ($source))
1105 $queryParameters [
'source'] = $source;
1107 $queryParameters = $this->appendArrayFields($queryParameters,
"ids", $contactIds);
1108 $queryParameters = $this->appendArrayFields($queryParameters,
"emails", $contactEmails);
1109 $queryParameters = $this->appendArrayFields($queryParameters,
"eids", $contactExternalIds);
1111 if (isset ($mailingIds)) {
1112 $queryParameters [
'mailing_id'] = array();
1114 foreach ($mailingIds as $mailingId) {
1115 $queryParameters [
'mailing_id'] [] = $mailingId;
1118 return $queryParameters;
getSubscribersCount($fromDate=null, $toDate=null, $mailingIds=array(), $contactIds=array(), $contactEmails=array(), $contactExternalIds=array(), $excludeAnonymousContacts=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)
getUnsubscribers($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $source=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)
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)
getBlocksCount($fromDate=null, $toDate=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $reasons=null, $oldStatus=null, $newStatus=null, $excludeAnonymousBlocks=false)
getUniqueClicksCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousClicks=false)
getBouncesCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $statusCodeFilter=null, $typeFilter=null, $sourceFilter=null, $excludeAnonymousBounces=false)
getRecipientsCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeDeletedRecipients=false)
getUniqueBouncesCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousBounces=false)
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)
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)
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)
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)
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)
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)
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)
getUniqueOpensCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $excludeAnonymousOpens=false)
getOpensCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $formatFilter=null, $socialNetworkFilter=null, $deviceTypeFilter=null, $excludeAnonymousOpens=false)
getUnsubscribersCount($fromDate=null, $toDate=null, $mailingIds=null, $contactIds=null, $contactEmails=null, $contactExternalIds=null, $source=null)