Retrieve

Overview 

Retrieves information about events occurring related to a message send

Syntax 

Retrieve(1)

Function Properties 

OrdinalTypeDescription
1stringRequiredCriteria 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:

1var sendID = 12345;
2var filter = { Property:"SendID", SimpleOperator:"equals", Value:sendID };
3var bounces = BounceEvent.Retrieve(filter);