Tracking events
SOAP-style tracking event namespaces — each exposes Retrieve(filter) for send metrics (bounce, click, open, sent, unsub, not-sent, forward, survey).
These Core library objects expose tracking rows for email sends. Each namespace implements Retrieve(filter) with a WSProxy-style filter (for example { Property, SimpleOperator, Value } on SendID, subscriber keys, or job fields appropriate to your query).
Requires Platform.Load("core", "1.1.5") before use.
Summary
| Object | Purpose |
|---|---|
BounceEvent |
Hard bounce, soft bounce, and related bounce outcomes |
ClickEvent |
Link clicks |
OpenEvent |
Opens |
SentEvent |
Sent / delivery hand-off events |
UnsubEvent |
Unsubscribe events |
NotSentEvent |
Messages that did not send |
ForwardedEmailEvent |
Forwarded-email tracking |
ForwardedEmailOptInEvent |
Forward opt-in tracking |
SurveyEvent |
Survey response events |
BounceEvent
BounceEvent exposes bounce outcomes for email sends. Only Retrieve exists on this namespace. Supply filter criteria that match how your account stores send and subscriber identifiers.
Methods
| Method | Returns | Description |
|---|---|---|
BounceEvent.Retrieve(filter) |
object[] | Bounce events matching the filter |
Syntax
BounceEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria for the search |
Return value
object[] — matching bounce events.
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var bounces = BounceEvent.Retrieve(filter);
ClickEvent
ClickEvent returns click tracking rows. Use criteria such as send ID, subscriber key, or URL identifiers depending on your reporting needs.
Methods
| Method | Returns | Description |
|---|---|---|
ClickEvent.Retrieve(filter) |
object[] | Click events matching the filter |
Syntax
ClickEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var clicks = ClickEvent.Retrieve(filter);
OpenEvent
OpenEvent returns open tracking data. Filter by send, subscriber, job, or other properties exposed on the event object for your account.
Methods
| Method | Returns | Description |
|---|---|---|
OpenEvent.Retrieve(filter) |
object[] | Open events matching the filter |
Syntax
OpenEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var opens = OpenEvent.Retrieve(filter);
SentEvent
SentEvent exposes sent events (distinct from opens/clicks/bounces). Align filters with how send and subscriber identifiers are stored for your queries.
Methods
| Method | Returns | Description |
|---|---|---|
SentEvent.Retrieve(filter) |
object[] | Sent events matching the filter |
Syntax
SentEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var sent = SentEvent.Retrieve(filter);
UnsubEvent
UnsubEvent returns unsubscribe tracking rows. Combine filters on send ID, subscriber key, or related fields as needed.
Methods
| Method | Returns | Description |
|---|---|---|
UnsubEvent.Retrieve(filter) |
object[] | Unsubscribe events matching the filter |
Syntax
UnsubEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var unsubs = UnsubEvent.Retrieve(filter);
NotSentEvent
NotSentEvent surfaces cases where a message did not send. Filter properties depend on the fields exposed for your jobs (send ID, reason codes, subscriber identifiers, etc.).
Methods
| Method | Returns | Description |
|---|---|---|
NotSentEvent.Retrieve(filter) |
object[] | Not-sent events matching the filter |
Syntax
NotSentEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var notSent = NotSentEvent.Retrieve(filter);
ForwardedEmailEvent
ForwardedEmailEvent returns rows when recipients forward email through tracked forward mechanics.
Methods
| Method | Returns | Description |
|---|---|---|
ForwardedEmailEvent.Retrieve(filter) |
object[] | Forwarded-email events matching the filter |
Syntax
ForwardedEmailEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var forwards = ForwardedEmailEvent.Retrieve(filter);
ForwardedEmailOptInEvent
ForwardedEmailOptInEvent captures opt-in actions associated with forwarded-email flows when that tracking is enabled for your account.
Methods
| Method | Returns | Description |
|---|---|---|
ForwardedEmailOptInEvent.Retrieve(filter) |
object[] | Events matching the filter |
Syntax
ForwardedEmailOptInEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var optIns = ForwardedEmailOptInEvent.Retrieve(filter);
SurveyEvent
SurveyEvent returns survey interaction rows linked to email sends when surveys are configured for tracking.
Methods
| Method | Returns | Description |
|---|---|---|
SurveyEvent.Retrieve(filter) |
object[] | Survey events matching the filter |
Syntax
SurveyEvent.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style criteria |
Return value
object[]
Examples
Platform.Load("core", "1");
var sendID = 12345;
var filter = { Property: "SendID", SimpleOperator: "equals", Value: sendID };
var surveys = SurveyEvent.Retrieve(filter);