Visitor privacy API data objects

Visitors are returned as JSON objects.

Available fields

Parameter Type Description
transaction_id string A unique ID returned in every response for logging purposes and the status API.
live boolean Set to true if the visitor is currently in a live session.
visitor object The visitor object with sub-objects for each of the attribute data types:
Visitor IDs
secondary_ids : { }
Numbers/Array of Numbers
"metrics" : { }
"metric_lists" : { }
Strings/Array of Strings/Set of Strings
"properties" : { }
"property_lists" : { }
"property_sets" : { }
Booleans/Array of Booleans
"flags" : { }
"flag_lists" : { }
Dates
"dates" : { }
Badges
"badges" : { }
Tallies
"metric_sets" : { }

Example response

{
    "transaction_id": "a1b23bcb4b5b56",
    "live": false,
    "visitor": {
        "metrics": {
            "Weeks since first visit": 0.14,
            "Total referred visits": 11,
            "Lifetime visit count": 12,
            "Average visit duration in minutes": 0.36,
            "Lifetime event count": 35,
            "Total time spent on site in minutes": 4.27,
            "Total direct visits": 1
        },
        "dates": {
            "Last visit": 1521217490000,
            "last_visit_start_ts": 1521217490000,
            "First visit": 1521134626000
        },
        "properties": {
            "Lifetime browser versions used (favorite)": "Chrome",
            "Lifetime browser types used (favorite)": "Chrome",
            "profile": "main",
            "Lifetime devices used (favorite)": "Mac desktop",
            "Lifetime platforms used (favorite)": "browser",
            "Last event URL": "http://www.tealium.com/",
            "account": "tealium",
            "Lifetime operating systems used (favorite)": "Mac OS X"
        },
        "flags": {
            "Returning visitor": true
        },
        "badges": ["Unbadged"],
        "metric_sets": {
            "Lifetime operating systems used": {
                "Mac OS X": 12
            },
            "Lifetime devices used": {
                "Mac desktop": 12
            },
            "Lifetime browser versions used": {
                "Chrome": 12
            },
            "Lifetime browser types used": {
                "Chrome": 12
            },
            "Lifetime platforms used": {
                "browser": 12
            }
        }
    }
}

Was this page helpful?

This page was last updated: January 7, 2023