Campaign Open Reports

Get a detailed report about any emails in a specific campaign that were opened by the recipient. Learn more about open tracking in MailChimp.

Available methods

    • Get campaign Open details

      GET /reports/{campaign_id}/open-details

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

      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.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      since Type: String Title: Campaign opens since Read only: false Restrict results to campaign open events that occur after a specific time.

      Response body parameters

      members Type: Array Title: Open Reports Read only: false 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.
      Show properties
      campaign_id Type: String Title: Campaign ID Read only: true The unique id for the campaign.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: true Email address for a subscriber.
      merge_fields Type: Object Title: Member Merge Var Read only: true An individual merge var and value for a member.
      vip Type: Boolean Title: VIP Read only: true VIP status for subscriber.
      opens_count Type: Integer Title: Opens count Read only: true The total number of times the this campaign was opened by the list member.
      opens Type: Array Title: Time series data of opens activity Read only: false 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.
      Show properties
      timestamp Type: String Title: Timestamp Read only: false The date and time recorded for the action.
      _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.
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id.
      total_opens Type: Integer Title: Total opens Read only: false The total number of opens matching the query regardless of pagination.
      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.

      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.