Working with Visitors

Overview

The following operations allow you to work with visitors. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with visitors, see Sample configuration .

Operation	Description
getAllVisitors	Retrieves all visitors' profiles.

Operation Details

This section provides further details on the operations related to Visitors.

Get All Visitors

The getAllVisitors operation retrieves all visitors.

getAllVisitors

<eloquaStandardAPI.getAllVisitors>
    <count>2</count>
    <search></search>
    <page>1</page>
    <orderBy></orderBy>
    <lastUpdatedAt>1426066807</lastUpdatedAt>
</eloquaStandardAPI.getAllVisitors>

properties

count : The number of results in a page to display. This must me in between 1 and 1000.
search :The search field, to search for that field.
page :The page number to display. This must be greater than 1.
orderBy :The order by property to order the fields.
lastUpdatedAt :The date time of the last update.

Sample request

Following is a sample REST/JSON request that can be handled by the getAllVisitors operation.

Sample request for getAllVisitors

{   
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "count":2,
   "page":1,
   "lastUpdatedAt":1426066807
}

Sample Configuration

Following is a sample proxy service that illustrates how to connect to Eloqua Standard API with the init operation to use the getAllVisitors operation. The sample request for this proxy can be found in getAllVisitors sample request . You can use this sample as a template for using other operations in this category.

Sample proxy

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="eloqua_getAllVisitors"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
    <target>
        <inSequence>
            <property name="siteName" expression="json-eval($.siteName)"/>
            <property name="username" expression="json-eval($.username)"/>
            <property name="password" expression="json-eval($.password)"/>
            <property name="count" expression="json-eval($.count)"/>
            <property name="search" expression="json-eval($.search)"/>
            <property name="page" expression="json-eval($.page)"/>
            <property name="orderBy" expression="json-eval($.orderBy)"/>
            <property name="lastUpdatedAt" expression="json-eval($.lastUpdatedAt)"/>
            <eloquaStandardAPI.init>
                <siteName>{$ctx:siteName}</siteName>
                <username>{$ctx:username}</username>
                <password>{$ctx:password}</password>
            </eloquaStandardAPI.init>
            <eloquaStandardAPI.getAllVisitors>
                <count>{$ctx:count}</count>
                <search>{$ctx:search}</search>
                <page>{$ctx:page}</page>
                <orderBy>{$ctx:orderBy}</orderBy>
                <lastUpdatedAt>{$ctx:lastUpdatedAt}</lastUpdatedAt>
            </eloquaStandardAPI.getAllVisitors>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </target>
    <description/>
</proxy>