Retrieve
Overview
Retrieves information about events occurring related to a message sendSyntax
Retrieve(1)
| Ordinal | Type | Description | |
|---|---|---|---|
| 1 | string | Required | Criteria used to search for event |
The information can include these events:
- Click
- ForwardedEmail
- ForwardedEmailOptIn
- HardBounce
- NotSent
- Open
- OtherBounce
- Sent
- SoftBounce
- Survey
- Unsubscribe
Example
The sample code retrieves the bounce events for a given send based on the criteria provided:
var sendID = 12345;
var filter = { Property:"SendID", SimpleOperator:"equals", Value:sendID };
var bounces = BounceEvent.Retrieve(filter);