Detect trackers

You can detect trackers in real-time using Detect trackers in streaming conversations, or you can Detect trackers after the conversation.

Before detecting trackers, you need to select one or more trackers from the Managed Trackers Library or create your own Custom Trackers.

After selecting or creating trackers, you need to process a conversation. All trackers in Your Trackers are applied when you process a conversation. By default, trackers are enabled for all conversations.

Detect trackers after the conversation

You can detect trackers using the Conversations API Get conversation operation.


Before using this API, you must generate your authentication token (AUTH_TOKEN) as described in Authenticate.

Use Case

You recently selected some trackers from the Managed Trackers Library. Then you processed a conversation and have the conversation ID. You need to see the which trackers were detected. Then you can analyze the results and decide if you want to edit one of the Managed Trackers or create your own custom tracker.

Get conversation


To make a request from the API reference, see Get conversation.

Detect trackers in streaming conversations

For streaming conversations, uses the WebSocket protocol to process audio and provide conversation intelligence in real time. When you process a streaming conversation, all the Trackers in Your Trackers are automatically detected.

Before processing a streaming conversation, select one or more Trackers from the Managed Trackers Library or create your own Custom Trackers.

There are a few different methods of setting up your streaming conversations. For more information, see Streaming API.

After a streaming conversation ends and processing is complete, you can detect trackers using the Conversations API Get Conversation operation.

Interim results are available as described in Interim Results.

Request body example

    "type": "start_request",
    "insightTypes": [
    "config": {
      "confidenceThreshold": 0.9,
      "speechRecognition": {
        "encoding": "LINEAR16",
        "sampleRateHertz": 44100
      "meetingTitle": "Client Meeting",
      "trackers": {
        "enableAllTrackers": true, // default is true
        "interimResults": true // default is false
    "speaker": {
      "userId": "[email protected]",
      "name": "Jane"

Request parameters

typeThe type of request, in this case it is a request to start processing a streaming conversation.
insightTypesThe insights to be generated, in this case questions and action items.
configConfiguration details for this conversation. For details, see Streaming API.
confidenceThresholdMinimum confidence score that you can set for an API to consider it as valid insight.
  • encoding is the audio encoding for the WebSocket connection.
  • sampleRateHertz is the rate of the incoming audio stream.
meetingTitleThe name you provide for the meeting.
trackersTracker configuration settings.
enableAllTrackersEnables detection of all active trackers in your Managed Trackers Library.

For more information, see Trackers.

Enabled by default. To disable, change the value to false.
interimResultsEnables you to view detected trackers from transcripts in progress.

Interim results are disabled by default.
speakerSpeaker details, including userId which is their email address, and name.

Disable trackers

Trackers are enabled by default for all conversations. If you need to disable Trackers, change "enableAllTrackers": true to "enableAllTrackers": false in the preceding example.

Interim results

With interim results enabled, you can view trackers from transcripts in progress. Use interim results to detect trackers in time-critical situations before transcription is complete.

Interim results are disabled by default. To enable interim results, set "interimResults": true as shown in the previous example. When you set “interimResults”: true, detected trackers are included in an interim transcription request.

If you set “interimResults”: false, trackers are only detected in the final transcript.


    "type": "tracker_response",
    "trackers": [
        "id": "4476908732794496",
        "name": "Documents",
        "matches": [
            "value": "Documents",
            "messageRefs": [
                "id": "53867534-0459-4d22-b590-984ee82166aa",
                "text": "Anyways, so I will submit documents tomorrow.",
                "offset": 26
                "id": "4d20d90c-50a7-4594-bb10-2995dcd4bbd1",
                "text": "I will submit documents tomorrow.",
                "offset": 14
            "insightRefs": []

Response fields

The following fields are returned in the response body.

typeThe type of response, for Trackers the value is always tracker_response.
trackersEach detected Tracker is included with id, name, and matches.
idThe unique identifying integer for the Tracker.
nameThe name of the Tracker.
matchesMatches have a value corresponding to the Tracker name, followed by messageRefs and insightRefs.
messageRefsIdentifying information for the detected message, including the id, text, and offset.
insightRefsAny insights generated by the detected Tracker instance, such as question, action item, or follow-up including the id, text, and offset for each insight.