Retrieve visitor data
get
/api/rest/2.0/data/visitors
Retrieves all visitor data that matches the criteria specified by the request parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tominimal
by default. -
orderBy: string
Specifies the field by which list results are ordered. Possible values include:
visitorId
,contactId
,externalId
,customerGuid
,v_IPAddress
, andv_LastVisitDateAndTime
. -
page: integer
Specifies which page of visitors to return (the
count
parameter defines the number of visitors per page). If thepage
parameter is not supplied, 1 will be used by default. -
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : QueryResultVisitorViewData
Type:
object
Title:
Show Source
QueryResultVisitorViewData
-
elements:
array elements
Array of visitor data.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of visitor data.
Show Source
-
Array of:
object Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
Title:
Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
Nested Schema : Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
Type:
object
Title:
Show Source
Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
-
contactId:
string
The contact record Id associated to this profile, if any.
-
createdAt:
string
The date and time the visitor was created, expressed in Unix time.
-
id:
integer
The id of the visitor.
-
type:
string
The visitor's type in Eloqua.
-
visitorId:
string
The Id of the visitor profile.
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Retrieve a list of all the visitor data in your database:
GET /api/REST/2.0/data/visitors
Response:
{
"elements": [
{
"type": "VisitorViewData",
"visitorId": "88888",
"createdAt": "1395423247",
"V_IPAddress": "127.0.0.1",
"V_LastVisitDateAndTime": "1395426873",
"externalId": "a10746a6-2480-425b-9db7-f20f4ac1c37e",
"contactId": "8"
}
],
"page": 1,
"pageSize": 5,
"total": 1
}