Retrieve a list of visitor profile fields
get
/api/rest/2.0/assets/visitor/fields
Retrieves a list of visitor profile fields
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.
-
page: integer
Specifies which page of visitor profile fields to return (the count parameter defines the number of visitor profile fields per page). If the page parameter is not supplied, 1 will be used by default.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultProfileField
Type:
object
Title:
Show Source
QueryResultProfileField
-
elements:
array elements
Array of visitor profile fields.
-
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 profile fields.
Show Source
-
Array of:
object ProfileField
Title:
ProfileField
Nested Schema : ProfileField
Type:
object
Title:
Show Source
ProfileField
-
createdByName:
string
ProfileField_Field_CreatedByName_Description
-
dataType:
string
The visitor profile field's data type. Possible values are: text, 'text', 'largeText', 'date', or 'number'.
-
id:
string
Read Only:
true
Id of the visitor profile field. This is a read-only property. -
internalName:
string
The internal name of the visitor profile field.
-
length:
string
The value length of the field expressed in bytes.
-
name:
string
The name of the visitor profile field.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedByName:
string
ProfileField_Field_UpdatedByName_Description
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 of the visitor profile fields in your database:
GET /api/REST/2.0/assets/visitor/fields
Response:
{
"elements": [{
"type": "ProfileField",
"id": "264",
"name": "Customer Guid",
"dataType": "text",
"internalName": "CustomerGuid",
"length": "50"
}, {
"type": "ProfileField",
"id": "157",
"name": "Browser",
"dataType": "text",
"internalName": "V_Browser_Type",
"length": "50"
}, {
"type": "ProfileField",
"id": "256",
"name": "City (from IP)",
"dataType": "text",
"internalName": "V_CityFromIP",
"length": "50"
}, {
"type": "ProfileField",
"id": "210",
"name": "Company DNS Name",
"dataType": "text",
"internalName": "V_CompanyDNSName",
"length": "50"
}, {
"type": "ProfileField",
"id": "246",
"name": "Company (from IP)",
"dataType": "largeText",
"internalName": "V_CompanyNameFromIP1",
"length": "200"
}, {
"type": "ProfileField",
"id": "245",
"name": "Country (from IP)",
"dataType": "text",
"internalName": "V_CountryFromIP",
"length": "50"
}, {
"type": "ProfileField",
"id": "241",
"name": "Country (from DNS)",
"dataType": "text",
"internalName": "V_CountryName",
"length": "50"
}, {
"type": "ProfileField",
"id": "169",
"name": "Current Total Pages",
"dataType": "number",
"internalName": "V_Current_Total_Pages",
"length": "4"
}, {
"type": "ProfileField",
"id": "168",
"name": "Current Visit Length",
"dataType": "number",
"internalName": "V_Current_Visit_Length",
"length": "4"
}, {
"type": "ProfileField",
"id": "217",
"name": "First Page In Visit",
"dataType": "largeText",
"internalName": "V_FirstPageInVisit",
"length": "200"
}, {
"type": "ProfileField",
"id": "212",
"name": "First Visit Date and Time",
"dataType": "date",
"internalName": "V_FirstVisitDateAndTime",
"length": "8"
}, {
"type": "ProfileField",
"id": "160",
"name": "Internet Site",
"dataType": "text",
"internalName": "V_HostName",
"length": "50"
}, {
"type": "ProfileField",
"id": "162",
"name": "IPAddress",
"dataType": "text",
"internalName": "V_IPAddress",
"length": "50"
}, {
"type": "ProfileField",
"id": "254",
"name": "ISP (from IP)",
"dataType": "largeText",
"internalName": "V_ISPFromIP",
"length": "200"
}, {
"type": "ProfileField",
"id": "231",
"name": "Last Page In Visit",
"dataType": "text",
"internalName": "V_LastPageInVisit",
"length": "50"
}, {
"type": "ProfileField",
"id": "232",
"name": "Last Visit Date and Time",
"dataType": "date",
"internalName": "V_LastVisitDateAndTime",
"length": "8"
}, {
"type": "ProfileField",
"id": "258",
"name": "Latitude (from IP)",
"dataType": "text",
"internalName": "V_LatitudeFromIP",
"length": "50"
}, {
"type": "ProfileField",
"id": "259",
"name": "Longitude (from IP)",
"dataType": "text",
"internalName": "V_LongitudeFromIP",
"length": "50"
}, {
"type": "ProfileField",
"id": "167",
"name": "Name",
"dataType": "text",
"internalName": "V_Name",
"length": "50"
}, {
"type": "ProfileField",
"id": "255",
"name": "State/Province (from IP)",
"dataType": "text",
"internalName": "V_ProvinceFromIP",
"length": "50"
}, {
"type": "ProfileField",
"id": "240",
"name": "Time Zone",
"dataType": "text",
"internalName": "V_TimeZone",
"length": "50"
}, {
"type": "ProfileField",
"id": "239",
"name": "Time Zone Offset from GMT",
"dataType": "number",
"internalName": "V_TimeZoneOffsetMin",
"length": "4"
}, {
"type": "ProfileField",
"id": "164",
"name": "Total Pages",
"dataType": "number",
"internalName": "V_Total_Pages",
"length": "4"
}, {
"type": "ProfileField",
"id": "165",
"name": "Total Time",
"dataType": "number",
"internalName": "V_Total_Time",
"length": "4"
}, {
"type": "ProfileField",
"id": "166",
"name": "Total Visits",
"dataType": "number",
"internalName": "V_Total_Visits",
"length": "4"
}, {
"type": "ProfileField",
"id": "257",
"name": "Zip Code (from IP)",
"dataType": "text",
"internalName": "V_ZipCodeFromIP",
"length": "50"
}],
"page": 1,
"pageSize": 1000,
"total": 26
}