Get Visitor Data

Last update: Wed Jun 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

This method is used to get real-time visitor identification data.

  • You must become a Web Personalization customer and have the RTP tag deployed on your site prior to using the User Context API.
  • RTP does not support Account Based Marketing named account lists. ABM lists and code only pertain to the uploaded account lists (CSV files) managed within RTP.

If an error occurs, there will be an error message as part of the response JSON. If a 500 code is returned, contact support with the request you made.

Parameter
Optional/Required
Type
Description
get
Required
String
Method action.
visitor
Required
String
Method name.
callback
Required
Function
Callback function to be triggered for each campaign returned.

Examples

Get visitor identification data:

function callbackFunction() {
    console.log('RTP is awesome!');
}
rtp('get', 'visitor', callbackFunction);

Response with Segment Match:

Below is an example response that is returned in case the visitor matched real-time segments prior to the Get Visitor Data API call.

{
    "status": 200,
    "results": {
        "matchedSegments": [
            {
                "name": "first click",
                "id": 177
            }
        ],
        "abm": [
            {
                "code": 4,
                "name": "abm_saleforce_customers"
            },
            {
                "code": 5,
                "name": "abm_top_customers"
            }
        ],
        "org": "Marketo",
        "location": {
            "country": "United States",
            "city": "San Mateo",
            "state": "CA"
        },
        "industries": [
            "Software & Internet"
        ],
        "isp": false
    }
}

Response without Segment Match:

Below is an example response that is returned in case the visitor did not match any real-time segments prior to the Get Visitor Data API call.

{
    "status": 200,
    "results": {
        "abm": [
            {
                "code": 4,
                "name": "abm_saleforce_customers"
            },
            {
                "code": 5,
                "name": "abm_top_customers"
            }
        ],
        "org": "Marketo",
        "location": {
            "country": "United States",
            "city": "San Mateo",
            "state": "CA"
        },
        "industries": [
            "Software & Internet"
        ],
        "isp": false
    }
}
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59