Manage Data Layer Enrichment Public API

The Data Layer Enrichment Public API allows you to retrieve a visitor profile for a known visitor ID while that visitor has an active visit. You can combine the Data Layer Enchrichment Public API with the Customer Data Hub Profile Definition API to improve personalization experience on your websites.

GET a Visitor Profile

Use the following GET command to retrieve a visitor profile:

**GET** http(s)://visitor-service.tealiumiq.com/{account}/{profile}/{visitor_id}

Example response

   {
        "metrics" : {
            "5117" : 6.0,
            "22" : 6.0
        },
        "dates" : {
            "5111" : 1420223771043
        },
        "properties" : {
            "17" : "http://tags.tiqcdn.com/utag/acct/prof/env/mobile.html",
            "account" : "tealiummobile",
            "5123" : "set",
            "profile" : "demo"
        },
        "flags" : { "5115" : true } ,
        "current_visit" : {
            "metrics" : {
                "7" : 6.0
            },
            "dates" : {
                "5202" : 1420225387000
            },
            "properties" : {
                "48" : "Chrome",
                "45" : "Mac OS X",
                "44" : "Chrome",
                "47" : "browser",
                "46" : "Mac desktop"
            },
            "flags" : { }
        },
        "badges" : { "5113" : true },
        "audiences" : {
            "tealiummobile_demo_101" : "Sample Audience"
        }
    }

If the supplied Visitor ID is invalid, or if the visitor does not currently have an active visit, the API returns status code 200 and an empty JSON.

The returned visitor profile differs from the typical visitor profile in the following ways:

  • Badges and audiences are transformed from an array to a map
  • Timelines and funnels have been removed

If Tealium AudienceStream CDP has not finished processing the AudienceStream request, meaning the visitor profile is not yet available at the time of the Data Layer Enrichment request, an empty JSON is returned.

A Data Layer Enrichment service handles all enrichment requests. The visitor profile is stored and delivered from this service and updated every five (5) seconds.

Was this page helpful?

This page was last updated: January 7, 2023