class MailchimpReports in Mailchimp 8

Mailchimp Reports library.

@package Mailchimp

Hierarchy

• class \Mailchimp\Mailchimp
  • class \Mailchimp\MailchimpReports

1 string reference to 'MailchimpReports'

MailchimpCampaignController::stats in modules/mailchimp_campaign/src/Controller/MailchimpCampaignController.php

View a Mailchimp campaign stats.

File

lib/mailchimp-api-php/src/MailchimpReports.php, line 10

Namespace

Mailchimp

class MailchimpReports extends Mailchimp {

  /**
   * Gets a report summary for the authenticated account.
   *
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   *
   * @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/#read-get_reports
   */
  public function getSummary($parameters = []) {
    return $this
      ->request('GET', '/reports', NULL, $parameters);
  }

  /**
   * Gets a report summary for a specific campaign.
   *
   * @param string $campaign_id
   *   The ID of the campaign.
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   *
   * @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/#read-get_reports_campaign_id
   */
  public function getCampaignSummary($campaign_id, $parameters = []) {
    $tokens = [
      'campaign_id' => $campaign_id,
    ];
    return $this
      ->request('GET', '/reports/{campaign_id}', $tokens, $parameters);
  }

  /**
   * Gets a specific report for a specific campaign.
   *
   * @param string $campaign_id
   *   The ID of the campaign.
   * @param string $type
   *   The type of report to generate path url.
   *    - abuse-reports       @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/abuse-reports
   *    - advice              @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/advice
   *    - click-details       @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/click-details
   *    - domain-performance  @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/domain-performance
   *    - eepurl              @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/eepurl
   *    - email-activity      @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/email-activity
   *    - locations           @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/locations
   *    - sent-to             @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/sent-to
   *    - sub-reports         @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/sub-reports
   *    - unsubscribed        @see http://developer.mailchimp.com/documentation/mailchimp/reference/reports/unsubscribed
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   */
  public function getCampaignReport($campaign_id, $type, $parameters = []) {
    $tokens = [
      'campaign_id' => $campaign_id,
      'type' => $type,
    ];
    return $this
      ->request('GET', '/reports/{campaign_id}/{type}', $tokens, $parameters);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Mailchimp::$api_key	private	property	The Mailchimp API key to authenticate with.
Mailchimp::$api_user	private	property	The Mailchimp API username to authenticate with.
Mailchimp::$batch_operations	private	property	Array of pending batch operations.
Mailchimp::$client	protected	property	The HTTP client.
Mailchimp::$debug_error_code	private	property	A Mailchimp API error code to return with every API response.
Mailchimp::$endpoint	protected	property	The REST API endpoint.
Mailchimp::$version	public	property	API version.
Mailchimp::addBatchOperation	protected	function	Adds a pending batch operation.
Mailchimp::DEFAULT_DATA_CENTER		constant
Mailchimp::ERROR_CODE_API_KEY_INVALID		constant
Mailchimp::ERROR_CODE_API_KEY_MISSING		constant
Mailchimp::ERROR_CODE_BAD_REQUEST		constant
Mailchimp::ERROR_CODE_COMPLIANCE_RELATED		constant
Mailchimp::ERROR_CODE_FORBIDDEN		constant
Mailchimp::ERROR_CODE_INTERNAL_SERVER_ERROR		constant
Mailchimp::ERROR_CODE_INVALID_ACTION		constant
Mailchimp::ERROR_CODE_INVALID_METHOD_OVERRIDE		constant
Mailchimp::ERROR_CODE_INVALID_RESOURCE		constant
Mailchimp::ERROR_CODE_JSON_PARSE_ERROR		constant
Mailchimp::ERROR_CODE_METHOD_NOT_ALLOWED		constant
Mailchimp::ERROR_CODE_REQUESTED_FIELDS_INVALID		constant
Mailchimp::ERROR_CODE_RESOURCE_NESTING_TOO_DEEP		constant
Mailchimp::ERROR_CODE_RESOURCE_NOT_FOUND		constant
Mailchimp::ERROR_CODE_TOO_MANY_REQUESTS		constant
Mailchimp::ERROR_CODE_USER_DISABLED		constant
Mailchimp::ERROR_CODE_WRONG_DATACENTER		constant
Mailchimp::getAccount	public	function	Gets Mailchimp account information for the authenticated account.
Mailchimp::getBatchOperation	public	function	Gets the status of a batch request.
Mailchimp::getDataCenter	private	function	Gets the ID of the data center associated with an API key.
Mailchimp::getDefaultHttpClient	private	function	Instantiates a default HTTP client based on the local environment.
Mailchimp::processBatchOperations	public	function	Processes all pending batch operations.
Mailchimp::request	public	function	Makes a request to the Mailchimp API.
Mailchimp::setClient	public	function	Sets a custom HTTP client to be used for all API requests.
Mailchimp::setDebugErrorCode	public	function	Sets a Mailchimp error code to be returned by all requests.
Mailchimp::VERSION		constant
Mailchimp::__construct	public	function	Mailchimp constructor.	7
MailchimpReports::getCampaignReport	public	function	Gets a specific report for a specific campaign.
MailchimpReports::getCampaignSummary	public	function	Gets a report summary for a specific campaign.
MailchimpReports::getSummary	public	function	Gets a report summary for the authenticated account.