Class Reports

MailChimp\MailChimp

Extended by

MailChimp\Reports\Reports

Namespace: MailChimp\Reports
Located at Reports/Reports.php

Methods summary

`public object`	# `getCamapaignReports( array $query = [] )` Get a list of templates for the account Get a list of templates for the account Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. array["folder_id"] string Filter results by a specific campaign folder. array["type"] string The campaign type. Possible values: regular,plaintext,absplit,rss,variate array["before_send_time"] string Restrict the response to campaigns sent before the set time. ISO 8601 time format: 2015-10-21T15:41:36+00:00. array["since_send_time"] string Restrict the response to campaigns sent after the set time. ISO 8601 time format: 2015-10-21T15:41:36+00:00. Parameters `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getCampaignReport( string $campaign_id, array $query = [] )` Get a list of campaigns for the account Get a list of campaigns for the account Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getAbuseReports( string $campaign_id, array $query = [] )` Get a list of abuse complaints for a specific campaign. Get a list of abuse complaints for a specific campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getAbuseReport( string $campaign_id, string $report_id, array $query = [] )` Get information about a specific abuse report for a campaign. Get information about a specific abuse report for a campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$report_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getAdvice( string $campaign_id, array $query = [] )` Get feedback based on a campaign’s statistics. Get feedback based on a campaign’s statistics. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getClickReports( string $campaign_id, array $query = [] )` Get information about clicks on specific links in your MailChimp campaigns. Get information about clicks on specific links in your MailChimp campaigns. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getClickReport( string $campaign_id, string $link_id, array $query = [] )` Get click details for a specific link. Get click details for a specific link. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$link_id` $report_id `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getClickReportMembers( string $campaign_id, string $link_id, array $query = [] )` Get information about list members who clicked on a specific link in a campaign. Get information about list members who clicked on a specific link in a campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$campaign_id` `$link_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getClickReportMember( string $campaign_id, string $link_id, string $subscriber_hash, array $query = [] )` Get information about a specific subscriber who clicked a link in a specific campaign. Get information about a specific subscriber who clicked a link in a specific campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$link_id` `$subscriber_hash` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getDomainPerformance( string $campaign_id, array $query = [] )` Get statistics for the top-performing email domains in a campaign. Get statistics for the top-performing email domains in a campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getSocialActivity( string $campaign_id, array $query = [] )` Get a summary of social activity for the campaign, tracked by EepURL. Get a summary of social activity for the campaign, tracked by EepURL. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getEmailActivity( string $campaign_id, array $query = [] )` Get a list of member’s subscriber activity in a specific campaign. Get a list of member’s subscriber activity in a specific campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getMemberActivity( string $campaign_id, string $subscriber_hash, array $query = [] )` Get a specific list member’s activity in a campaign including opens, clicks, and bounces. Get a specific list member’s activity in a campaign including opens, clicks, and bounces. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$subscriber_hash` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getTopLocations( string $campaign_id, array $query = [] )` Get top open locations for a specific campaign. Get top open locations for a specific campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getSentToMembers( string $campaign_id, array $query = [] )` Get information about campaign recipients. Get information about campaign recipients. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getSentToMember( string $campaign_id, string $subscriber_hash, array $query = [] )` Get information about a specific campaign recipient. Get information about a specific campaign recipient. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$subscriber_hash` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getSubReports( string $campaign_id, array $query = [] )` Get a list of reports with child campaigns for a specific parent campaign. Get a list of reports with child campaigns for a specific parent campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getUnsubscribedMembers( string $campaign_id, array $query = [] )` Get information about members who have unsubscribed from a specific campaign. Get information about members who have unsubscribed from a specific campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$campaign_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getUnsubscribedMember( string $campaign_id, string $subscriber_hash, array $query = [] )` Get information about a specific list member who unsubscribed from a campaign. Get information about a specific list member who unsubscribed from a campaign. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$campaign_id` `$subscriber_hash` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()