Eloqua Read

Eloqua Read

On this Page

 

Snap type:

Read

 

Description:

This Snap connects to the Eloqua endpoint (https://login.eloqua.com/id), fetches the base URI for the REST API, appends the core object involved to the URI and connects to it, and returns the result to a document stream.

Prerequisites:

[None]

 

Support and limitations:

Works in Ultra Tasks.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Eloqua Account for more information.

Views:

Input

This Snap has at most one document input view (as of 4.3.2).

Output

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.

Settings

Label

 

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

 

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

  • Visitors 2.0

Example: Contacts
Default value: Accounts

 

Depth

 

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

Default value: minimal

 

Page Size

Maximum number of entities to fetch from a single call to the Eloqua endpoint. This is used for the 'count' parameter of the Eloqua endpoint API. 

Consider using a smaller value when a single page is likely to contain a large amount of data, such as when Depth is 'complete'. The Snap automatically fetches multiple pages and combines the results into a single document list.

Maximum Value: 1000

Default Value: 1000

Count

 

Maximum number of total entities to return. If not specified, all entities will be returned. The Snap automatically handles fetching multiple pages and combining the results into a single list of documents to return at most the number of entities specified.

This is not the COUNT parameter from the Eloqua endpoint.


Default value: [None]

Search

 

This property specifies the search criteria used to retrieve entities. This is in the form of [{term} {operator}] {value}, where {term} is the name of a field to filter on, {operator} is the comparison operator, and {value} is the value to compare the field with.
Note: If {term} and {operator} are not supplied, the 'name' field is compared to the value using the equality operator.
Default value: [None]
 

Additional parameters

 

A table that contains name-value pairs for custom parameters.
Default value: [None]

 

Pass through

 

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

Default Value: Deselected

Snap Execution

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