List child campaign reports

GET

https://api.mailchimp.com/3.0/reports/:campaign_id/sub-reports

GET

/3.0/reports/:campaign_id/sub-reports

curl https://api.mailchimp.com/3.0/reports/campaign_id/sub-reports \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "campaign_id": "string",
  "reports": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "ab_split": {
        "a": {
          "abuse_reports": 1,
          "bounces": 1,
          "forwards": 1,
          "forwards_opens": 1,
          "last_open": "string",
          "opens": 1,
          "recipient_clicks": 1,
          "unique_opens": 1,
          "unsubs": 1
        },
        "b": {
          "abuse_reports": 1,
          "bounces": 1,
          "forwards": 1,
          "forwards_opens": 1,
          "last_open": "string",
          "opens": 1,
          "recipient_clicks": 1,
          "unique_opens": 1,
          "unsubs": 1
        }
      },
      "abuse_reports": 1,
      "bounces": {
        "hard_bounces": 1,
        "soft_bounces": 1,
        "syntax_errors": 1
      },
      "campaign_title": "string",
      "clicks": {
        "click_rate": 1.1,
        "clicks_total": 1,
        "last_click": "2024-01-15T09:30:00Z",
        "unique_clicks": 1,
        "unique_subscriber_clicks": 1
      },
      "delivery_status": {
        "can_cancel": true,
        "emails_canceled": 1,
        "emails_sent": 1,
        "enabled": true,
        "status": "delivering"
      },
      "ecommerce": {
        "currency_code": "USD",
        "total_orders": 1,
        "total_revenue": 1.1,
        "total_spent": 1.1
      },
      "emails_sent": 1,
      "facebook_likes": {
        "facebook_likes": 1,
        "recipient_likes": 1,
        "unique_likes": 1
      },
      "forwards": {
        "forwards_count": 1,
        "forwards_opens": 1
      },
      "id": "string",
      "industry_stats": {
        "abuse_rate": 1.1,
        "bounce_rate": 1.1,
        "click_rate": 1.1,
        "open_rate": 1.1,
        "type": "string",
        "unopen_rate": 1.1,
        "unsub_rate": 1.1
      },
      "list_id": "string",
      "list_is_active": true,
      "list_name": "string",
      "list_stats": {
        "click_rate": 1.1,
        "open_rate": 1.1,
        "proxy_excluded_open_rate": 1.1,
        "sub_rate": 1.1,
        "unsub_rate": 1.1
      },
      "opens": {
        "last_open": "2024-01-15T09:30:00Z",
        "open_rate": 1.1,
        "opens_total": 1,
        "proxy_excluded_open_rate": 1.1,
        "proxy_excluded_opens": 1,
        "proxy_excluded_unique_opens": 1,
        "unique_opens": 1
      },
      "preview_text": "string",
      "rss_last_send": "2024-01-15T09:30:00Z",
      "send_time": "2024-01-15T09:30:00Z",
      "share_report": {
        "share_password": "string",
        "share_url": "string"
      },
      "subject_line": "string",
      "timeseries": [
        {
          "emails_sent": 1,
          "proxy_excluded_unique_opens": 1,
          "recipients_clicks": 1,
          "timestamp": "2024-01-15T09:30:00Z",
          "unique_opens": 1
        }
      ],
      "timewarp": [
        {
          "bounces": 1,
          "clicks": 1,
          "gmt_offset": 1,
          "last_click": "2024-01-15T09:30:00Z",
          "last_open": "2024-01-15T09:30:00Z",
          "opens": 1,
          "unique_clicks": 1,
          "unique_opens": 1
        }
      ],
      "type": "string",
      "unsubscribed": 1
    }
  ],
  "total_items": 1
}

Get a list of reports with child campaigns for a specific parent campaign.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

campaign_idstringRequired

The unique id for the campaign.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

campaign_idstringOptional

Unique identifier of the parent campaign

reportslist of objectsOptional

An array of objects, each representing a report resource.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.