In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at email@example.com.
This API allows you to get all the Trackers from your conversation.
Authorization(Recommended) - This header should contain a valid Bearer token generated using the
token:generateAPI Endpoint by passing in the credentials. You can read more about authentication here.
X-API-KEY(Legacy) - Use the
Authorizationheader. This has been deprecated. This header should contain a valid authentication token generated using the
token:generateAPI Endpoint by passing in the credentials. These can be obtained by signing up on the Platform.
Content-Type(Required) - This header must contain the MIME Type
Before using the Conversation API you must get the authentication token (
AUTH_TOKEN) from our authentication process.
Let’s go over the members of the response body which contains the detected tracker objects:
id: The id of the detected Tracker.
name: The name of the Tracker.
matches: Array of match objects which contain the references to messages and insights detected in that conversation.
messageRefs: Array of messages for which this Tracker was detected.
id: The unique identifier of the message.
text: The text body of the message.
offset: The closest match of the text in the
message. Offset of
-1means that an exact match for that specific vocabulary wasn’t found and this was the similar match. An offset greater than 0 indicates an exact match for the tracker in the payload of the
matchtype for the text. In the above example, the match is of type
value: The textual value of the
vocabularyfor which this match was detected.
insightRefs: Array of insights for which this
Trackerwas detected. This has the same structure that