Visitor Data API allow to send any information about a website visitor that your systems have to our Visitor Journey Module displayed to agents.
The GetData
method enables the retrieval of visitor-related data associated with user.
GET /VisitorData/GetData/{accountId}/{visitorId}/{includeSensitiveData}
{accountId}
- guid - ID of the account associated with the website.{visitorId}
- string - Unique visitor ID, identifying a specific user.{includeTEData}
- boolean - Indicates whether data collected by TrueEngage should be included in the response. Use true
to include data and false
to exclude it.It is recommended to include the following headers:
X-TrueEngage-ApiKey
- string - ApiKey allowing authorization for the request.Example Usage:
curl --location '<https://visitordataapi.trueengage.com/VisitorData/GetData/130/dddcaf8a-efa0-4db4-b0b8-7f261e01c81d/false>' \\
--header 'X-TrueEngage-ApiKey: XXX'
This example demonstrates how to retrieve data for a specific visitor identified by {visitorId}
, associated with the account identified by {accountId}
, without including sensitive data.
The SaveData
method enables the saving of visitor-related data associated with user interactions on a website.