Eloqua Query Activities

In this article

Overview

This Snap is used to retrieve the activities associated with one or more Eloqua contact asset.  It invokes the Eloqua REST API 1.0 "Read (list)" endpoint for Activities.

  • Expected input: The typical input for this Snap would be documents containing Eloqua contact IDs, such as the output of the Eloqua Read Snap for the Contacts type.

  • Expected output: One output document per contact ID, containing the contact ID and a list of zero or more activities for that contact.

Snap Type

The Eloqua Query Activities Snap is a Read-type Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

JSON Generator

This Snap has one document input view.

Output

Document

 

  • Min: 1

  • Max: 1

Mapper

 

This Snap has exactly one document output view.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field Name

Field Type

Field Dependency

Description

Label

Default Value: Eloqua Query Activities

Example: Create Accounts

String

N/A

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Contact ID

Example:
Default value:

String

N/A

Required. ID of the Eloqua contact associated with the activities of interest, or an expression which evaluates to a contact ID.

Activity Type

Dropdown List

N/A

Required. The type of activity you wish to retrieve for the specified contact.  One of:

  • emailOpen

  • emailSend

  • emailClickThrough

  • emailSubscribe

  • emailUnsubscribe

  • formSubmit

  • webVisit

  • campaignMembership

Start Date/Time

String

N/A

Required. Start of the time range for activities to retrieve.  This should be a 10-digit Unix timestamp, or an expression that evaluates to a timestamp or a DateTime. See Unix Time Stamp - Epoch Converter .

Examples:

  • 1341343693

  • Date.now().minusDays(30)

  • Date.parse("2015-12-25T12:00:00+00:00")

End Date/Time

String

N/A

Required. End of the time range for activities to retrieve.

Count

String

N/A

Maximum number of activities to retrieve for each contact.  This is not a limit on the number of documents to output, which is always equal to the number of input documents (or 1 if there are no input documents).

Pass through

Default Value: Deselected

Checkbox

N/A

Select this checkbox to enable the Snap to pass the input document to the output view under the key original.

 

Snap Execution

 

Dropdown list

N/A

 

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

 

Examples


Sample input:

[ { "id": "4156" }, { "id": "4157" }, { "id": "4158" } ]

Sample output:

[ { "contactId" : "4156", "activities" : [ { "type" : "Activity", "activityDate" : "1403589324", "activityType" : "emailSubscribe", "asset" : "0", "assetType" : "email", "contact" : "4156", "details" : [ ], "id" : "130345" }, { "type" : "Activity", "activityDate" : "1341343693", "activityType" : "emailSubscribe", "asset" : "0", "assetType" : "email", "contact" : "4156", "details" : [ ], "id" : "2947" } ] }, { "contactId" : "4157", "activities" : [ ] }, { "contactId" : "4158", "activities" : [ { "type" : "Activity", "activityDate" : "1341343693", "activityType" : "emailSubscribe", "asset" : "0", "assetType" : "email", "contact" : "4158", "details" : [ ], "id" : "2948" } ] } ]


Snap Pack History