---
title: "List campaign open details"
method: GET
path: "/3.0/reports/{campaign_id}/open-details"
tags: ["reports"]
---

# List campaign open details

`GET /3.0/reports/{campaign_id}/open-details`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/reports/{campaign_id}/open-details`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/reports/:campaign_id/open-details/get.ts> (a function with typed inputs; its response is checked against the schema)

Get detailed information about any campaign emails that were opened by a list member.

## Path parameters

- `campaign_id` string, required

## Query parameters

- `fields` string[]
- `exclude_fields` string[]
- `count` integer
- `offset` integer
- `since` string
- `sort_field` 'opens_count'
- `sort_dir` 'ASC' | 'DESC'
- `filter_bots` boolean

## Response `200`

- object: A detailed report of any campaign emails that were opened by a list member.
  - `_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.
  - `campaign_id` string: The campaign id.
  - `members` object[]: An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event.
    - `_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.
    - `campaign_id` string: The unique id for the campaign.
    - `contact_status` string: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.
    - `email_address` string: Email address for a subscriber.
    - `email_id` string: The MD5 hash of the lowercase version of the list member's email address.
    - `list_id` string: The unique id for the list.
    - `list_is_active` boolean: The status of the list used, namely if it's deleted or disabled.
    - `merge_fields` object, nullable: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.
    - `opens` object[]: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event.
      - `is_proxy_open` boolean: Indicates if the open was from an email client that use proxies.
      - `timestamp` string, date-time: The date and time recorded for the action in ISO 8601 format.
    - `opens_count` integer: The total number of times the this campaign was opened by the list member.
    - `proxy_excluded_opens_count` integer: The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies .
    - `vip` boolean: [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.
  - `total_items` integer: The total number of items matching the query regardless of pagination.
  - `total_opens` integer: The total number of opens matching the query regardless of pagination.
  - `total_proxy_excluded_opens` integer: The total number of opens excluding opens from email clients that use proxies regardless of pagination.

## 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)
