Tracking events

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: BounceEvent
 *
 * CloudPage GET context. Proves:
 *   1. BounceEvent requires the Core load and is then an object exposing
 *      exactly the documented static Retrieve (Stringify shows only that
 *      member).
 *   2. There is no Init / Add / Update / Remove on this namespace — only
 *      Retrieve exists.
 *   3. BounceEvent.Retrieve(filter) with a WSProxy-style SendID filter
 *      returns a host array: typeof "object", Object.prototype.toString
 *      "[object Array]", numeric .length, .push is a function,
 *      instanceof Array is false (engine-wide host-array quirk).
 *   4. A nonsense SendID yields length 0 and Stringify "[]" — still a
 *      valid object[].
 *   5. The page example shape (Property/SimpleOperator/Value on SendID)
 *      runs without throwing.
 *   6. DEVIATION "DEV": Retrieve() with the required filter omitted does
 *      NOT throw — it still returns a host array with numeric .length
 *      (page Parameters table marks filter Required; result may be empty
 *      or populated depending on account history).
 *   7. Retrieve({}) with an empty object throws.
 *
 * NON-ASSERTABLE: exact bounce-row field names/values (page documents
 * only object[]; no historical bounce rows are guaranteed for a given
 * SendID).
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

/* 1 + 2. Availability and Methods table — only Retrieve. */
assert("typeof BounceEvent is object", typeOf(function () { return typeof BounceEvent; }), "object");
assert("typeof BounceEvent.Retrieve is function", typeOf(function () { return typeof BounceEvent.Retrieve; }), "function");
assert("BounceEvent.Init does not exist", typeOf(function () { return typeof BounceEvent.Init; }), "undefined");
assert("BounceEvent.Add does not exist", typeOf(function () { return typeof BounceEvent.Add; }), "undefined");
assert("BounceEvent.Update does not exist", typeOf(function () { return typeof BounceEvent.Update; }), "undefined");
assert("BounceEvent.Remove does not exist", typeOf(function () { return typeof BounceEvent.Remove; }), "undefined");
assert("BounceEvent exposes exactly Retrieve", "" + Stringify(BounceEvent), '{"Retrieve":"function"}');

/* 3 + 4. Empty-match return shape (object[]). */
var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = BounceEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

/* 5. Page example shape. */
assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return BounceEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

/* 6. DEV — Required filter is not enforced at the call site. */
var omitted = BounceEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return BounceEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

/* 7. Empty-object filter is rejected. */
assert("Retrieve({}) throws", invocationResult(function () { return BounceEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: ClickEvent
 *
 * CloudPage GET context. Proves:
 *   1. ClickEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. ClickEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact click-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof ClickEvent is object", typeOf(function () { return typeof ClickEvent; }), "object");
assert("typeof ClickEvent.Retrieve is function", typeOf(function () { return typeof ClickEvent.Retrieve; }), "function");
assert("ClickEvent.Init does not exist", typeOf(function () { return typeof ClickEvent.Init; }), "undefined");
assert("ClickEvent.Add does not exist", typeOf(function () { return typeof ClickEvent.Add; }), "undefined");
assert("ClickEvent.Update does not exist", typeOf(function () { return typeof ClickEvent.Update; }), "undefined");
assert("ClickEvent.Remove does not exist", typeOf(function () { return typeof ClickEvent.Remove; }), "undefined");
assert("ClickEvent exposes exactly Retrieve", "" + Stringify(ClickEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = ClickEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return ClickEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = ClickEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return ClickEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return ClickEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: OpenEvent
 *
 * CloudPage GET context. Proves:
 *   1. OpenEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. OpenEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact open-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof OpenEvent is object", typeOf(function () { return typeof OpenEvent; }), "object");
assert("typeof OpenEvent.Retrieve is function", typeOf(function () { return typeof OpenEvent.Retrieve; }), "function");
assert("OpenEvent.Init does not exist", typeOf(function () { return typeof OpenEvent.Init; }), "undefined");
assert("OpenEvent.Add does not exist", typeOf(function () { return typeof OpenEvent.Add; }), "undefined");
assert("OpenEvent.Update does not exist", typeOf(function () { return typeof OpenEvent.Update; }), "undefined");
assert("OpenEvent.Remove does not exist", typeOf(function () { return typeof OpenEvent.Remove; }), "undefined");
assert("OpenEvent exposes exactly Retrieve", "" + Stringify(OpenEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = OpenEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return OpenEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = OpenEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return OpenEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return OpenEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: SentEvent
 *
 * CloudPage GET context. Proves:
 *   1. SentEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. SentEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact sent-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof SentEvent is object", typeOf(function () { return typeof SentEvent; }), "object");
assert("typeof SentEvent.Retrieve is function", typeOf(function () { return typeof SentEvent.Retrieve; }), "function");
assert("SentEvent.Init does not exist", typeOf(function () { return typeof SentEvent.Init; }), "undefined");
assert("SentEvent.Add does not exist", typeOf(function () { return typeof SentEvent.Add; }), "undefined");
assert("SentEvent.Update does not exist", typeOf(function () { return typeof SentEvent.Update; }), "undefined");
assert("SentEvent.Remove does not exist", typeOf(function () { return typeof SentEvent.Remove; }), "undefined");
assert("SentEvent exposes exactly Retrieve", "" + Stringify(SentEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = SentEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return SentEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = SentEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return SentEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return SentEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: UnsubEvent
 *
 * CloudPage GET context. Proves:
 *   1. UnsubEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. UnsubEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact unsub-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof UnsubEvent is object", typeOf(function () { return typeof UnsubEvent; }), "object");
assert("typeof UnsubEvent.Retrieve is function", typeOf(function () { return typeof UnsubEvent.Retrieve; }), "function");
assert("UnsubEvent.Init does not exist", typeOf(function () { return typeof UnsubEvent.Init; }), "undefined");
assert("UnsubEvent.Add does not exist", typeOf(function () { return typeof UnsubEvent.Add; }), "undefined");
assert("UnsubEvent.Update does not exist", typeOf(function () { return typeof UnsubEvent.Update; }), "undefined");
assert("UnsubEvent.Remove does not exist", typeOf(function () { return typeof UnsubEvent.Remove; }), "undefined");
assert("UnsubEvent exposes exactly Retrieve", "" + Stringify(UnsubEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = UnsubEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return UnsubEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = UnsubEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return UnsubEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return UnsubEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: NotSentEvent
 *
 * CloudPage GET context. Proves:
 *   1. NotSentEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. NotSentEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact not-sent-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof NotSentEvent is object", typeOf(function () { return typeof NotSentEvent; }), "object");
assert("typeof NotSentEvent.Retrieve is function", typeOf(function () { return typeof NotSentEvent.Retrieve; }), "function");
assert("NotSentEvent.Init does not exist", typeOf(function () { return typeof NotSentEvent.Init; }), "undefined");
assert("NotSentEvent.Add does not exist", typeOf(function () { return typeof NotSentEvent.Add; }), "undefined");
assert("NotSentEvent.Update does not exist", typeOf(function () { return typeof NotSentEvent.Update; }), "undefined");
assert("NotSentEvent.Remove does not exist", typeOf(function () { return typeof NotSentEvent.Remove; }), "undefined");
assert("NotSentEvent exposes exactly Retrieve", "" + Stringify(NotSentEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = NotSentEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return NotSentEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = NotSentEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return NotSentEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return NotSentEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: ForwardedEmailEvent
 *
 * CloudPage GET context. Proves:
 *   1. ForwardedEmailEvent is an object exposing exactly Retrieve after
 *      Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. ForwardedEmailEvent.Retrieve(filter) returns a host array.
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact forward-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof ForwardedEmailEvent is object", typeOf(function () { return typeof ForwardedEmailEvent; }), "object");
assert("typeof ForwardedEmailEvent.Retrieve is function", typeOf(function () { return typeof ForwardedEmailEvent.Retrieve; }), "function");
assert("ForwardedEmailEvent.Init does not exist", typeOf(function () { return typeof ForwardedEmailEvent.Init; }), "undefined");
assert("ForwardedEmailEvent.Add does not exist", typeOf(function () { return typeof ForwardedEmailEvent.Add; }), "undefined");
assert("ForwardedEmailEvent.Update does not exist", typeOf(function () { return typeof ForwardedEmailEvent.Update; }), "undefined");
assert("ForwardedEmailEvent.Remove does not exist", typeOf(function () { return typeof ForwardedEmailEvent.Remove; }), "undefined");
assert("ForwardedEmailEvent exposes exactly Retrieve", "" + Stringify(ForwardedEmailEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = ForwardedEmailEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return ForwardedEmailEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = ForwardedEmailEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return ForwardedEmailEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return ForwardedEmailEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: ForwardedEmailOptInEvent
 *
 * CloudPage GET context. Proves:
 *   1. ForwardedEmailOptInEvent is an object exposing exactly Retrieve
 *      after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. ForwardedEmailOptInEvent.Retrieve(filter) returns a host array.
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact opt-in-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof ForwardedEmailOptInEvent is object", typeOf(function () { return typeof ForwardedEmailOptInEvent; }), "object");
assert("typeof ForwardedEmailOptInEvent.Retrieve is function", typeOf(function () { return typeof ForwardedEmailOptInEvent.Retrieve; }), "function");
assert("ForwardedEmailOptInEvent.Init does not exist", typeOf(function () { return typeof ForwardedEmailOptInEvent.Init; }), "undefined");
assert("ForwardedEmailOptInEvent.Add does not exist", typeOf(function () { return typeof ForwardedEmailOptInEvent.Add; }), "undefined");
assert("ForwardedEmailOptInEvent.Update does not exist", typeOf(function () { return typeof ForwardedEmailOptInEvent.Update; }), "undefined");
assert("ForwardedEmailOptInEvent.Remove does not exist", typeOf(function () { return typeof ForwardedEmailOptInEvent.Remove; }), "undefined");
assert("ForwardedEmailOptInEvent exposes exactly Retrieve", "" + Stringify(ForwardedEmailOptInEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = ForwardedEmailOptInEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return ForwardedEmailOptInEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = ForwardedEmailOptInEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return ForwardedEmailOptInEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return ForwardedEmailOptInEvent.Retrieve({}); }), "threw");
</script>

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);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: SurveyEvent
 *
 * CloudPage GET context. Proves:
 *   1. SurveyEvent is an object exposing exactly Retrieve after Core load.
 *   2. No Init / Add / Update / Remove on this namespace.
 *   3. SurveyEvent.Retrieve(filter) returns a host array (object[] shape).
 *   4. A nonsense SendID yields length 0 / Stringify "[]".
 *   5. The page example shape runs without throwing.
 *   6. DEV: Retrieve() with the required filter omitted does not throw;
 *      result is still a host array with numeric .length.
 *   7. Retrieve({}) throws.
 *
 * NON-ASSERTABLE: exact survey-row field schemas / non-empty matches.
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof SurveyEvent is object", typeOf(function () { return typeof SurveyEvent; }), "object");
assert("typeof SurveyEvent.Retrieve is function", typeOf(function () { return typeof SurveyEvent.Retrieve; }), "function");
assert("SurveyEvent.Init does not exist", typeOf(function () { return typeof SurveyEvent.Init; }), "undefined");
assert("SurveyEvent.Add does not exist", typeOf(function () { return typeof SurveyEvent.Add; }), "undefined");
assert("SurveyEvent.Update does not exist", typeOf(function () { return typeof SurveyEvent.Update; }), "undefined");
assert("SurveyEvent.Remove does not exist", typeOf(function () { return typeof SurveyEvent.Remove; }), "undefined");
assert("SurveyEvent exposes exactly Retrieve", "" + Stringify(SurveyEvent), '{"Retrieve":"function"}');

var filter = { Property: "SendID", SimpleOperator: "equals", Value: 999999991 };
var rows = SurveyEvent.Retrieve(filter);
assert("typeof Retrieve result is object", typeof rows, "object");
assert("Retrieve result reports as [object Array]", Object.prototype.toString.call(rows), "[object Array]");
assert("Retrieve result exposes a numeric .length", typeof rows.length, "number");
assert("no-match SendID length is 0", "" + rows.length, "0");
assert("Retrieve result exposes .push", typeof rows.push, "function");
assert("instanceof Array is false (engine-wide host-array quirk)", rows instanceof Array ? "true" : "false", "false");
assert("no-match Stringify is []", "" + Stringify(rows), "[]");

assert("page example: Retrieve({SendID equals 12345}) returns", invocationResult(function () { return SurveyEvent.Retrieve({ Property: "SendID", SimpleOperator: "equals", Value: 12345 }); }), "returned");

var omitted = SurveyEvent.Retrieve();
assert("DEV Retrieve() without filter does not throw (docs: filter Required)", invocationResult(function () { return SurveyEvent.Retrieve(); }), "returned");
assert("DEV Retrieve() without filter still returns [object Array] (docs: filter Required)", Object.prototype.toString.call(omitted), "[object Array]");
assert("DEV Retrieve() without filter exposes numeric .length (docs: filter Required)", typeof omitted.length, "number");

assert("Retrieve({}) throws", invocationResult(function () { return SurveyEvent.Retrieve({}); }), "threw");
</script>

Tracking events

Summary

BounceEvent

Methods

Syntax

Parameters

Return value

Examples

ClickEvent

Methods

Syntax

Parameters

Return value

Examples

OpenEvent

Methods

Syntax

Parameters

Return value

Examples

SentEvent

Methods

Syntax

Parameters

Return value

Examples

UnsubEvent

Methods

Syntax

Parameters

Return value

Examples

NotSentEvent

Methods

Syntax

Parameters

Return value

Examples

ForwardedEmailEvent

Methods

Syntax

Parameters

Return value

Examples

ForwardedEmailOptInEvent

Methods

Syntax

Parameters

Return value

Examples

SurveyEvent

Methods

Syntax

Parameters

Return value

Examples

See also

See Also