Eloqua Query

In this article

Overview

This Snap connects to an Eloqua REST API "Read (single)" endpoint to retrieve Eloqua assets or data objects with a specified type and IDs. 

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

 

 

 

Type

Format

 

 

 

Input 

Document

  • Min: 0

  • Max: 1

JSON Generator

This Snap has at most one document input view, which can be used to supply documents containing object IDs.  The Snap will invoke the Eloqua endpoint once for each input document.

Output

Document

 

  • Min: 1

  • Max: 1

Mapper

 

This Snap has exactly one document output view and produces one document in the view for each successful call to the Eloqua endpoint.

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

Field Type

Field Dependency

Description

Field

Field Type

Field Dependency

Description

Label*

Default Value: Eloqua Query Activities

Example:

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.

Core object type

Default valueAccounts

ExampleContacts

Dropdown list

N/A

Required. The type of core object involved in the query. The options available include:

  • Accounts

  • Accounts 2.0

  • Account Fields

  • Account Fields 2.0

  • Campaigns

  • Campaigns 2.0

  • Contacts

  • Contacts 2.0

  • Contact Fields

  • Contact Fields 2.0

  • Contact Lists

  • Contact Lists 2.0

  • Contact Segments

  • Contact Segments 2.0

  • Content Sections

  • Content Sections 2.0

  • Custom Object Data

  • Custom Object Metadata

  • Custom Object Metadata 2.0

  • Emails

  • Emails 2.0

  • Email Folders

  • Email Folders 2.0

  • Email Footers

  • Email Footers 2.0

  • Email Groups

  • Email Groups 2.0

  • Email Headers

  • Email Headers 2.0

  • External Activities 2.0

  • External Assets 2.0

  • External Asset Types 2.0

  • Forms

  • Forms 2.0

  • Form Submission Data

  • Images 2.0

  • Imported Files 2.0

  • Landing Pages

  • Landing Pages 2.0

  • Microsites

  • Microsites 2.0

  • Option Lists

  • Option Lists 2.0

  • System Users

  • System Users 2.0

All types without a specified version number are version 1.0.

 

Depth

Default value: minimal

 

 

 

The depth or level of detail returned. The options available include:

  • minimal (entity name, type, ID, date created, date last updated, date last accessed)

    • partial (All of the entity's properties are returned and if the entity is related to other objects, those entities are returned at minimal depth.)

    • complete (All of the entity's properties are returned and all related entities are returned at complete depth.)

ID

Default value: [None]

Dropdown list
 

N/A

Required. An identifier for the entity or an expression that evaluates to one.  When there is an input view, this should be an expression that specifies the path of the ID value in each input document, such as "$id".

Additional parameters

Default value: [None]

Use this field set to define additional parameters

 

N/A

A table that contains name-value pairs for custom parameters.

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.

Snap Pack History