Context API endpoint

The endpoint on this page applies to engines with Public access. For engines that require authentication, subscribe to the Context API in the Developer Portal and use the API reference there to make authenticated requests. For more information, see Developer Portal API catalog.

How it works

The Context API engine creates a unique endpoint for your region, account, and profile. Each engine assigns a unique engine ID to each endpoint.

Data for visitors becomes available after you enable the engine and visitors log active sessions and generate events in the system. If you request data for a visitor and they have not logged an active session yet, the API will not return any data.

To retrieve visitor data, configure an Advanced JavaScript Code Extension to make a request to the Context API endpoint.

GET method

Use the GET method to retrieve audience, badge, and attribute data that you specified in your Context API engine.

Tealium anonymous visitor ID

GET  https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}/visitors/{IDENTIFIER}?suppressNotFound={SUPPRESS_NOT_FOUND}

This command uses the following parameters:

Visitor ID attribute

GET  https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}?attributeId={attributeId}&attributeValue={attributeValue}&suppressNotFound={SUPPRESS_NOT_FOUND}

This command uses the following parameters:

For more information about anonymous IDs and secondary visitor IDs, see Anonymous IDs, user identifiers, and visitor ID attributes.

Objects

Context API returns visitor data as JSON objects that contain the audience, badge, and attribute fields you specify in the engine configuration.

The following table summarizes the data types supported by Context API:

• Badge
• Boolean
• Date
• Number
• String

Attributes marked as PII are not supported.

You can configure audiences and visitor attributes to be returned with the UID or name, as seen in the following body examples:

Name example

The following example demonstrates a typical JSON payload that uses the names of attributes:

{
    "audiences": [
        "30 Days Since Last Login"
    ],
    "badges": [
        "Frequent visitor"
    ],
    "metrics": {
        "Total direct visits": 1
    },
    "properties": {
        "Company Name": "<attr_value>"
    },
    "flags": {
        "Returning visitor": false
    },
    "dates": {
        "First visit": 1491233145706
    }
}

UID example

The following example demonstrates a typical JSON payload that uses the UIDs of attributes:

{
    "audiences": [
        "tealium_main_205"
    ],
    "badges": [
        "31"
    ],
    "metrics": {
        "15": 1
    },
    "properties": {
        "27330": "<attr_value>"
    },
    "flags": {
        "27": false
    },
    "dates": {
        "23": 1491233145706
    }
}

Headers

The following HTTP headers are required in a Context API request:

• Referer - The value compared to the domain allow list. If the referrer and the allow list do not match, the request is refused.
  • Example: https://www.example.com/
• Origin - The value used to address CORS errors when calling the API from JavaScript.
  • Example: https://www.example.com/

Error messages

Potential error messages for this endpoint: