Visitor Lookup Tool

Visitor Lookup Tool

by Community Manager ‎04-06-2018 02:37 PM - edited ‎07-13-2018 02:28 PM (663 Views)

This article describes how to use the Visitor Lookup tool in AudienceStream. This tool is used to find and delete active visitor profiles within the Universal Data Hub (UDH) in support of General Data Protection Regulation (GDPR) compliance to satisfy the requirement of responding to data subject access requests.

In this article:

Table of Contents Placeholder

Overview

The Visitor Lookup tool in UDH is a visual version 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. visitors can then be deleted. The interface also offers a REST API screen for demonstrating how the API works. The new Visitor Lookup tool is located under the Tools section in the sidebar.

Search

Searching for a Visitor Record

To find a visitor record, you will need a known value for one of the Visitor ID attributes defined in your account.

To perform a visitor lookup:

  1. Navigate to Tools > Visitor Lookup.
  2. Select a visitor ID attribute from the drop-down list.
  3. Enter a known value for the selected attribute.
  4. Click Search. If the visitor record exists, the results will be displayed.
    visitor-lookup-search-field.png

Viewing a Visitor Record

When a visitor record is located there are two panels that display information about the visitor: 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 types is represented as keys in the object. Learn more about the fields available in the visitor object.

visitor-lookup-json-object.png

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 will be displayed.

Click the heading for each attribute type to expand its list of attributes.

visitor-lookup-filter-by.png 

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 will permanently remove its data from all components of the Universal Data Hub.

When deleting a visitor record using the selected attributes action in the AudienceStore connector, only the tealium_id is affected. This action does not purge the assigned visitor id (secondary id).

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 a visual guide 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 menu. Select a request type to view the details of that API call.

visitor-lookup-restapi-request-types.png