--- title: "Get campaign report" method: GET path: "/3.0/reports/{campaign_id}" tags: ["reports"] --- # Get campaign report `GET /3.0/reports/{campaign_id}` ## Request - Base URL: `https://api.mailchimp.com` - URL: `https://api.mailchimp.com/3.0/reports/{campaign_id}` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `https://login.mailchimp.com/oauth2/authorize` - Token URL: `https://login.mailchimp.com/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get report details for a specific sent campaign. ## Path parameters - `campaign_id` string, required ## Query parameters - `fields` string[] - `exclude_fields` string[] ## Response `200` - object: Report details about a sent campaign. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `ab_split` object: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. - `a` object: Stats for Campaign A. - `abuse_reports` integer: Abuse reports for Campaign A. - `bounces` integer: Bounces for Campaign A. - `forwards` integer: Forwards for Campaign A. - `forwards_opens` integer: Opens from forwards for Campaign A. - `last_open` string: The last open for Campaign A. - `opens` integer: Opens for Campaign A. - `recipient_clicks` integer: Recipient Clicks for Campaign A. - `unique_opens` integer: Unique opens for Campaign A. - `unsubs` integer: Unsubscribes for Campaign A. - `b` object: Stats for Campaign B. - `abuse_reports` integer: Abuse reports for Campaign B. - `bounces` integer: Bounces for Campaign B. - `forwards` integer: Forwards for Campaign B. - `forwards_opens` integer: Opens for forwards from Campaign B. - `last_open` string: The last open for Campaign B. - `opens` integer: Opens for Campaign B. - `recipient_clicks` integer: Recipients clicks for Campaign B. - `unique_opens` integer: Unique opens for Campaign B. - `unsubs` integer: Unsubscribes for Campaign B. - `abuse_reports` integer: The number of abuse reports generated for this campaign. - `bounces` object: An object describing the bounce summary for the campaign. - `hard_bounces` integer: The total number of hard bounced email addresses. - `soft_bounces` integer: The total number of soft bounced email addresses. - `syntax_errors` integer: The total number of addresses that were syntax-related bounces. - `campaign_title` string: The title of the campaign. - `clicks` object: An object describing the click activity for the campaign. - `click_rate` number: The number of unique clicks divided by the total number of successful deliveries. - `clicks_total` integer: The total number of clicks for the campaign. - `last_click` string, date-time: The date and time of the last recorded click for the campaign in ISO 8601 format. - `unique_clicks` integer: The total number of unique clicks for links across a campaign. - `unique_subscriber_clicks` integer: The total number of subscribers who clicked on a campaign. - `delivery_status` object: Updates on campaigns in the process of sending. - `can_cancel` boolean: Whether a campaign send can be canceled. - `emails_canceled` integer: The total number of emails canceled for this campaign. - `emails_sent` integer: The total number of emails confirmed sent for this campaign so far. - `enabled` boolean: Whether Campaign Delivery Status is enabled for this account and campaign. - `status` 'delivering' | 'delivered' | 'canceling' | 'canceled': The current state of a campaign delivery. - `ecommerce` object: E-Commerce stats for a campaign. - `currency_code` string - `total_orders` integer: The total orders for a campaign. - `total_revenue` number: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. - `total_spent` number: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. - `emails_sent` integer: The total number of emails sent for this campaign. - `facebook_likes` object: An object describing campaign engagement on Facebook. - `facebook_likes` integer: The number of Facebook likes for the campaign. - `recipient_likes` integer: The number of recipients who liked the campaign on Facebook. - `unique_likes` integer: The number of unique likes. - `forwards` object: An object describing the forwards and forward activity for the campaign. - `forwards_count` integer: How many times the campaign has been forwarded. - `forwards_opens` integer: How many times the forwarded campaign has been opened. - `id` string: A string that uniquely identifies this campaign. - `industry_stats` object: The average campaign statistics for your industry. - `abuse_rate` number: The industry abuse rate. - `bounce_rate` number: The industry bounce rate. - `click_rate` number: The industry click rate. - `open_rate` number: The industry open rate. - `type` string: The type of business industry associated with your account. For example: retail, education, etc. - `unopen_rate` number: The industry unopened rate. - `unsub_rate` number: The industry unsubscribe rate. - `list_id` string: The unique list id. - `list_is_active` boolean: The status of the list used, namely if it's deleted or disabled. - `list_name` string: The name of the list. - `list_stats` object: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. - `click_rate` number: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. - `open_rate` number: The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list. - `proxy_excluded_open_rate` number: The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies. - `sub_rate` number: The average number of subscriptions per month for the list. - `unsub_rate` number: The average number of unsubscriptions per month for the list. - `opens` object: An object describing the open activity for the campaign. - `last_open` string, date-time: The date and time of the last recorded open in ISO 8601 format. - `open_rate` number: The number of unique opens for a campaign divided by the total number of successful deliveries. - `opens_total` integer: The total number of opens for a campaign. - `proxy_excluded_open_rate` number: The average unique open rate for a campaign, excluding opens from email clients that use proxies. - `proxy_excluded_opens` integer: The total number of opens for a campaign, excluding opens from email clients that use proxies. - `proxy_excluded_unique_opens` integer: The total number of unique opens for a campaign, excluding opens from email clients that use proxies. - `unique_opens` integer: The total number of unique opens for a campaign. - `preview_text` string: The preview text for the campaign. - `rss_last_send` string, date-time: For RSS campaigns, the date and time of the last send in ISO 8601 format. - `send_time` string, date-time: The date and time a campaign was sent in ISO 8601 format. - `share_report` object: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). - `share_password` string: If password protected, the password for the VIP report. - `share_url` string: The URL for the VIP report. - `subject_line` string: The subject line for the campaign. - `timeseries` object[]: An hourly breakdown of the performance of the campaign over the first 24 hours. - `emails_sent` integer: The number of emails sent in the timeseries. - `proxy_excluded_unique_opens` integer: The number of unique opens in the timeseries, excluding opens from email clients that use proxies. - `recipients_clicks` integer: The number of clicks in the timeseries. - `timestamp` string, date-time: The date and time for the series in ISO 8601 format. - `unique_opens` integer: The number of unique opens in the timeseries. - `timewarp` object[]: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. - `bounces` integer: The number of bounces. - `clicks` integer: The number of clicks. - `gmt_offset` integer: For campaigns sent with timewarp, the time zone group the member is apart of. - `last_click` string, date-time: The date and time of the last click in ISO 8601 format. - `last_open` string, date-time: The date and time of the last open in ISO 8601 format. - `opens` integer: The number of opens. - `unique_clicks` integer: The number of unique clicks. - `unique_opens` integer: The number of unique opens. - `type` string: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). - `unsubscribed` integer: The total number of unsubscribed members for this campaign. ## Other responses - `default`: An error generated by the Mailchimp API. --- [API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)