Visitor lookup tool
This article explains the Visitor Loopup tool, which is a graphical interface of the Visitor Lookup API. A visitor lookup uses a visitor ID attribute and a search value to locate a visitor record in the system.
When a record is located, all the known attributes for that visitor are displayed for review. Visitor records can then be deleted. The interface also offers a REST API screen for demonstrating how the API works.
Search
To find a visitor record, visitor stitching must be enabled and you need a known value for one of the visitor ID attributes defined in your account.
Use the following steps to perform a visitor lookup:
- Go to Server-Side Tools > Visitor Lookup.
- Select an attribute from the drop-down list.
- Enter a known value for the selected attribute.
- Click Search.
If the visitor record exists, the results appear.
View a visitor record
When a visitor record is located, the information is displayed in two panels: the attribute filter panel on the left and the main JSON object panel.
JSON object
The main panel displays the raw JSON object of the visitor record. Each attribute data type is represented as keys in the object. Learn more about the fields available in the visitor object.
Attribute filter
The left panel provides an attribute filter to adjust the list of attributes that are displayed. Use the Filter by menu to choose between displaying All Attributes or Assigned attributes. When choosing Assigned, only attributes that have an assigned value for the currently located visitor profile appear. Click the heading for each attribute type to expand its list of attributes.
| Filter by All Attributes | Filter by Assigned Attributes |
|---|---|
|
|
Deleting a visitor
When a visitor record is located, you have the option to delete it. This process can take up to 24 hours to complete and the action cannot be undone.
Deleting a visitor record permanently removes its data from all components of the Customer Data Hub.
When you click Delete Visitor, a request is logged to our system to delete the visitor record and a transaction ID is returned to log the request. The delete request enters a queue and will be processed over the next 24 hours. If you search for the same visitor again and the record is not found, you will know the delete process has completed.
The transaction ID can be used in the Visitor Lookup API to check the status of the request.
REST API
The REST API tab provides an interface to the Visitor Lookup API. The API calls are pre-formatted for you as examples of how to implement the same functionality in your application. Select the API call you want to make and adjust the placeholder values in the request URL.
Each API call is available in the Request Types drop-down list. Select a request type to view the details of that API call.
This page was last updated: March 22, 2023