Preview Segment

Provide conditions to preview segment.

Available methods

    • Preview a segment

      POST /lists/{list_id}/preview-segment

      Preview a segment of users by sending conditions..

      Path parameters

      list_id The unique id for the list.

      Response body parameters

      members Type: Array Title: Members Read only: false An array of objects, each representing a specific list member.
      Show properties
      id Type: String Title: Email ID 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: false Email address for a subscriber.
      unique_email_id Type: String Title: Unique Email ID Read only: true An identifier for the address across all of Mailchimp.
      web_id Type: Integer Title: Member Web ID Read only: true The ID used in the Mailchimp web application. View this member in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      • transactional
      • archived
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      stats Type: Object Title: Subscriber Stats Read only: true Open and click rates for this subscriber.
      Show properties
      avg_open_rate Type: Number Title: Average Open Rate Read only: true A subscriber’s average open rate.
      avg_click_rate Type: Number Title: Average Click Rate Read only: true A subscriber’s average clickthrough rate.
      ecommerce_data Type: Object Title: Ecommerce Stats Read only: true Ecommerce stats for the list member if the list is attached to a store.
      Show properties
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue the list member has brought in.
      number_of_orders Type: Number Title: Total Number of Orders Read only: true The total number of orders placed by the list member.
      currency_code Type: String Title: Currency Read only: true The three-letter ISO 4217 code for the currency that the store accepts.
      ip_signup Type: String Title: Signup IP Read only: true IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: true The date and time the subscriber signed up for the list in ISO 8601 format.
      ip_opt Type: String Title: Opt-in IP Read only: true The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: true The date and time the subscribe confirmed their opt-in status in ISO 8601 format.
      member_rating Type: Integer Title: Member Rating Read only: true Star rating for this member, between 1 and 5.
      last_changed Type: String Title: Last Changed Date Read only: true The date and time the member’s info was last changed in ISO 8601 format.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      email_client Type: String Title: Email Client Read only: true The list member’s email client.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      gmtoff Type: Integer Title: GMT Offset Read only: true The time difference in hours from GMT.
      dstoff Type: Integer Title: DST Offset Read only: true The offset for timezones where daylight saving time is observed.
      country_code Type: String Title: Country Code Read only: true The unique code for the location country.
      timezone Type: String Title: Timezone Read only: true The timezone for the location.
      marketing_permissions Type: Array Title: Marketing Permissions Read only: false The marketing permissions for the subscriber.
      Show properties
      marketing_permission_id Type: String Title: Marketing Permission ID Read only: false The id for the marketing permission on the list
      text Type: String Title: Marketing Permission Text Read only: false The text of the marketing permission.
      enabled Type: Boolean Title: Enabled Read only: false If the subscriber has opted-in to the marketing permission.
      last_note Type: Object Title: Notes Read only: true The most recent Note added about this member.
      Show properties
      note_id Type: Integer Title: Note ID Read only: true The note id.
      created_at Type: String Title: Created Time Read only: true The date and time the note was created in ISO 8601 format.
      created_by Type: String Title: Author Read only: true The author of the note.
      note Type: String Title: Note Read only: true The content of the note.
      source Type: String Title: Subscriber Source Read only: false The source from which the subscriber was added to this list.
      tags_count Type: Integer Title: Tags Count Read only: true The number of tags applied to this member.
      tags Type: Array Title: Tags Read only: false The tags applied to this member.
      list_id Type: String Title: List ID Read only: true The list id.
      _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.
      list_id Type: String Title: List ID Read only: false The list id.
      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.