Domain Performance

Get statistics for the top-performing domains from a campaign.

Available methods

    • Get domain performance stats

      GET /reports/{campaign_id}/domain-performance

      Get statistics for the top-performing email domains in a campaign.

      Path parameters

      campaign_id The unique id for the campaign.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      domains Type: Array Title: Lists Read only: true The top 5 email domains based on total delivered emails.
      Show properties
      domain Type: String Title: Domain Read only: true The name of the domain (gmail.com, hotmail.com, yahoo.com).
      emails_sent Type: Integer Title: Total Sent Read only: true The number of emails sent to that specific domain.
      bounces Type: Integer Title: Bounces Read only: true The number of bounces at a domain.
      opens Type: Integer Title: Opens Read only: true The number of opens for a domain.
      clicks Type: Integer Title: Clicks Read only: true The number of clicks for a domain.
      unsubs Type: Integer Title: Unsubscribes Read only: true The total number of unsubscribes for a domain.
      delivered Type: Integer Title: Successful Deliveries Read only: true The number of successful deliveries for a domain.
      emails_pct Type: Number Title: Email Percent Read only: true The percentage of total emails that went to this domain.
      bounces_pct Type: Number Title: Bounces Percent Read only: true The percentage of total bounces from this domain.
      opens_pct Type: Number Title: Opens Percent Read only: true The percentage of total opens from this domain.
      clicks_pct Type: Number Title: Clicks Percent Read only: true The percentage of total clicks from this domain.
      unsubs_pct Type: Number Title: Unsubscribes Percent Read only: true The percentage of total unsubscribes from this domain.
      total_sent Type: Integer Title: Total Sent Read only: true The total number of emails sent for the campaign.
      campaign_id Type: String Title: Campaign ID Read only: true The unique id for the campaign.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/reports/42694e9e57/domain-performance' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 642
      Vary: Accept-Encoding
      X-Request-Id: aff42b27-4d0a-4991-bee6-ab6f4acb68d7
      Link: <https://api.mailchimp.com/schema/3.0/Reports/DomainPerformance/Collection.json>; rel="describedBy"
      Date: Thu, 17 Sep 2015 16:38:19 GMT
      Connection: keep-alive
      
      
      {
        "domains": [
          {
            "domain": "freddiesjokes.com",
            "emails_sent": 42,
            "bounces": 0,
            "opens": 23,
            "clicks": 43,
            "unsubs": 0,
            "delivered": 42,
            "emails_pct": 42,
            "bounces_pct": 0,
            "opens_pct": 42,
            "clicks_pct": 0,
            "unsubs_pct": 0
          }
        ],
        "total_sent": 42,
        "campaign_id": "42694e9e57",
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/domain-performance",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/DomainPerformance/Collection.json"
          }
        ],
        "total_items": 1
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.