MessageInsightsFilters

An object containing Message Insights filters.

If you specify multiple filters, the filters are joined by AND.

If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.

FromEmailAddress, Destination, and Subject filters support partial match. A partial match is performed by using the * wildcard character placed at the beginning (suffix match), the end (prefix match) or both ends of the string (contains match). In order to match the literal characters * or \, they must be escaped using the \ character. If no wildcard character is present, an exact match is performed.

Destination

The recipient's email address.

Type: Array of strings

Array Members: Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 320.

Required: No

FromEmailAddress

The from address used to send the message.

Type: Array of strings

Array Members: Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 320.

Required: No

Isp

The recipient's ISP (e.g., Gmail, Yahoo, etc.).

Type: Array of strings

Array Members: Maximum number of 5 items.

Required: No

LastDeliveryEvent

The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT.

Type: Array of strings

Array Members: Maximum number of 5 items.

Required: No

LastEngagementEvent

The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK.

Engagement events are only available if Engagement tracking is enabled.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: OPEN | CLICK

Required: No

Subject

The subject line of the message.

Type: Array of strings

Array Members: Maximum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 998.

Required: No

MessageInsightsFilters

Contents

See Also