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
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
  • Specifies the field by which list results are ordered. Possible values include: visitorId, contactId, externalId, customerGuid, v_IPAddress, and v_LastVisitDateAndTime.
  • Specifies which page of visitors to return (the count parameter defines the number of visitors per page). If the page parameter is not supplied, 1 will be used by default.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultVisitorViewData
Type: object
Title: QueryResultVisitorViewData
Show Source
Nested Schema : elements
Type: array
Array of visitor data.
Show Source
Nested Schema : Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
Type: object
Title: Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData
Show Source

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.
Back to Top

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
}
			
Back to Top