deliveryRecipientFilter
If you only pass in a deliveryId, a deliveryRecipientStatObject will be returned for each list or segment
the delivery was sent. If the delivery was only sent to a single contact, a deliveryRecipientStatObject will be returned for the single contact
delivery.
| Name | Type | Required | Description |
|---|---|---|---|
type |
filterType | Required if more than one filter is being defined. Defaults to
AND if no typeis specified. |
Used to define multiple filters. |
deliveryId |
string | Yes | The unique id of the delivery you want to read. |
listIds[] |
string or an array of strings | No | The unique id of a list or lists sent to in the delivery. This allows you to filter the request so only deliveryRecipientStatObjects for the specified lists are returned. |
segmentIds[] |
string or an array of strings | No | The unique id of a segment or segments sent to in the delivery. This allows you to filter the request so only deliveryRecipientStatObjects for the specified segments are returned. |
contactIds[] |
string or an array of strings | No | The unique id for a contact or contacts. Test deliveries can be sent to multiple single contacts. In this case, a deliveryRecipientStatObject is returned for each contact, because each send is considered a single contact delivery. You can filter the request to only return deliveryRecipientStatObjects for the specified contactIds. |