Get trackers

This guide describes how to use the Management API Get Tracker and Get Trackers operations.

If you want to detect trackers in conversations, you need to Create Trackers, or choose from the Managed Trackers Library.

All Trackers in Your Trackers are identified when you process a conversation. Trackers are enabled by default for all conversations.

Authentication

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

Use cases

Request parameters

The following request parameters cover all Get Trackers operations.

ParameterDescription
trackerIdThe unique string assigned to a tracker when it is created.
nameThe name you want to assign to this Tracker, in the form of a unique text string.
descriptionA sentence describing the Tracker, in the form of a unique text string.
categoriesOne or more category names for the Tracker to be assigned. This can be an existing category such as General and Sales, or a new category such as Marketing.
languagesOne or more of these predefined language values: en-US, en-GB, en-AU, en-IE, en-IN, en-ZA, es-US, es-ES.
vocabularyOne or more phrases based on a central theme. Taken as a whole, this array of strings define the meaning of the Tracker.
excludeVocabularyOne or more phrases to exclude from matching as part of this Tracker vocabulary. For example, you may want to exclude job promotion as a match if a tracker is focused on sales promotions.

Get tracker by ID

Submit a request to get a single Tracker by sending the trackerId in the URL.

GET <https://api.symbl.ai/v1/manage/trackers/{trackerId}>

To make a sample request directly from the API Reference, see Get Tracker.

Get tracker by ID request

To get a Tracker, use the GET <https://api.symbl.ai/v1/manage/trackers/{trackerId}> operation.

For example: GET <https://api.symbl.ai/v1/manage/trackers/5639193993674752>

You do not need to add any code to submit this URL-based operation.

Tracker ID is the only parameter needed.

For more detailed descriptions, see the Request Body Parameters table.

Get tracker by ID response

{
    "tracker": {
        "id": "5639193993674752",
        "name": "Online Website Support",
        "vocabulary": [
            "Website",
            "Website is down",
            "Website shows incorrect information",
            "Website crashed",
            "Website is not loading"
        ],
        "description": "Used to identify website support in the conversation",
        "categories": [
            "Call Center"
        ],
        "languages": [
            "en-IN"
        ],
        "createdOn": "2022-08-29T03:52:32.817Z",
        "updatedOn": "2022-08-29T03:57:45.737Z"
    }
}

Added response parameters

The following fields are added to the response body. Other response fields are described in the Request Parameters table.

FieldDescription
idThe Tracker ID, in the form of a unique integer string.
createdOnTimestamp when the Tracker was created.
updatedOnTimestamp when the Tracker was updated. Identical timestamps indicate no update.

Get trackers by name, category, or language

Submit a request to get trackers by name, category, or language.

GET <https://api.symbl.ai/v1/manage/trackers>

To make a sample request directly from the API Reference, see Get Trackers.

Get trackers by name request

To get trackers by name, use the GET <https://api.symbl.ai/v1/manage/trackers> operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const trackerParams = [
  {
    'name': '<TRACKER_NAME>',
  },
]

const fetchResponse = await fetch('https://api.symbl.ai/v1/manage/trackers', {
  method: 'get',
  body: JSON.stringify(trackerParams),
  headers: {
    'Authorization': 'Bearer ${accessToken}',
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.
  • <TRACKER_NAME> is the name you want to assign to each tracker, such as Website Support and Phone Call Support.

For more detailed descriptions, see the Request Parameters table.

Get trackers by name response

{
   "trackers": [
       {
           "id": "5745434338263040",
           "name": "Phone Call Support",
           "vocabulary": [
               "Helpline Number",
               "Alternative Contact Number",
               "Toll Free Number"
           ],
           "description": "Used to identify phone call support in the conversation",
           "categories": [
               "General",
               "Call Center"
           ],
           "languages": [
               "en-US",
               "en-IN"
           ],
           "createdOn": "2022-08-29T03:52:32.866Z",
           "updatedOn": "2022-08-29T03:52:32.866Z"
       }
   ]
}

Get trackers by category request

To get trackers by category, use the GET <https://api.symbl.ai/v1/manage/trackers> operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const trackerParams = [
  {
    'categories': [ 
      '<TRACKER_CATEGORY>',
      '<TRACKER_CATEGORY>'
      ...
    ]
  },
]

const fetchResponse = await fetch('https://api.symbl.ai/v1/manage/trackers', {
  method: 'get',
  body: JSON.stringify(trackerParams),
  headers: {
    'Authorization': 'Bearer ${accessToken}',
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.
  • <TRACKER_CATEGORY> are one or more category names for the tracker to be assigned. This can be an existing category such as Contact Center or a new category such as Website and Phone Support.

For more detailed descriptions, see the Request Parameters table.

Get trackers by category response

{
   "trackers": [
       {
           "id": "5654001296080896",
           "name": "Insurance Tracker",
           "vocabulary": [
               "Insurance",
               "Health Insurance",
               "Car Insurance"
           ],
           "description": "Used to identify insurance keyword in the conversation",
           "categories": [
               "General"
           ],
           "languages": [
               "en-US",
               "en-IN"
           ],
           "createdOn": "2022-08-29T03:43:47.381Z",
           "updatedOn": "2022-08-29T03:43:47.381Z"
       },
       {
           "id": "5700838862356480",
           "name": "Intent Detection",
           "vocabulary": [
               "I would love to hear more about what you have to offer",
               "Where I can go to and look at all these details myself",
               "Talk soon"
           ],
           "description": "Intent detection check",
           "categories": [
               "General"
           ],
           "languages": [
               "en-US"
           ],
           "createdOn": "2022-08-19T13:29:02.668Z",
           "updatedOn": "2022-08-19T13:29:02.668Z"
       },
       {
           "id": "5723906796158976",
           "name": "Of course, I can look that up for you.",
           "vocabulary": [
               "Of course, I can look that up for you."
           ],
           "description": "Of course, I can look that up for you.",
           "categories": [
               "General"
           ],
           "languages": [
               "en-US"
           ],
           "createdOn": "2022-08-20T17:11:51.611Z",
           "updatedOn": "2022-08-20T17:11:51.611Z"
       },
       {
           "id": "5742687815729152",
           "name": "hello tracker",
           "vocabulary": [
               "Hello",
               "Live demo"
           ],
           "description": "hello",
           "categories": [
               "General"
           ],
           "languages": [
               "en-AU"
           ],
           "createdOn": "2022-08-18T09:01:33.291Z",
           "updatedOn": "2022-08-18T09:01:33.291Z"
       },
       {
           "id": "5745434338263040",
           "name": "Phone Call Support",
           "vocabulary": [
               "Helpline Number",
               "Alternative Contact Number",
               "Toll Free Number"
           ],
           "description": "Used to identify phone call support in the conversation",
           "categories": [
               "General",
               "Call Center"
           ],
           "languages": [
               "en-US",
               "en-IN"
           ],
           "createdOn": "2022-08-29T03:52:32.866Z",
           "updatedOn": "2022-08-29T03:52:32.866Z"
       }
   ]
}

Get trackers by language request

To get trackers by language, use the GET <https://api.symbl.ai/v1/manage/trackers> operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const trackerParams = [
  {
    'languages': [
      '<TRACKER_LANG>',
      '<TRACKER_LANG>'
      ...
    ]
  },
]

const fetchResponse = await fetch('https://api.symbl.ai/v1/manage/trackers', {
  method: 'get',
  body: JSON.stringify(trackerParams),
  headers: {
    'Authorization': 'Bearer ${accessToken}',
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

For more detailed descriptions, see the Request Parameters table.

Get trackers by language response

{
    "trackers": [
        {
            "id": "5639193993674752",
            "name": "Online Website Support",
            "vocabulary": [
                "Website",
                "Website is down",
                "Website shows incorrect information",
                "Website crashed",
                "Website is not loading"
            ],
            "description": "Used to identify website support in the conversation",
            "categories": [
                "Call Center"
            ],
            "languages": [
                "en-IN"
            ],
            "createdOn": "2022-08-29T03:52:32.817Z",
            "updatedOn": "2022-08-29T03:57:45.737Z"
        },
        {
            "id": "5647427546644480",
            "name": "Symbl.Upsell_Opportunity",
            "vocabulary": [],
            "description": "Used to identify opportunities to upsell or upgrade a product or service in a conversation.",
            "categories": [
                "Sales"
            ],
            "languages": [
                "en-US",
                "en-GB",
                "en-AU",
                "en-IE",
                "en-IN",
                "en-ZA"
            ],
            "createdOn": "2022-08-19T15:14:15.906Z",
            "updatedOn": "2022-08-19T15:14:15.906Z"
        },
        {
            "id": "5654001296080896",
            "name": "Insurance Tracker",
            "vocabulary": [
                "Insurance",
                "Health Insurance",
                "Car Insurance"
            ],
            "description": "Used to identify insurance keyword in the conversation",
            "categories": [
                "General"
            ],
            "languages": [
                "en-US",
                "en-IN"
            ],
            "createdOn": "2022-08-29T03:43:47.381Z",
            "updatedOn": "2022-08-29T03:43:47.381Z"
        },
        {
            "id": "5745434338263040",
            "name": "Phone Call Support",
            "vocabulary": [
                "Helpline Number",
                "Alternative Contact Number",
                "Toll Free Number"
            ],
            "description": "Used to identify phone call support in the conversation",
            "categories": [
                "General",
                "Call Center"
            ],
            "languages": [
                "en-US",
                "en-IN"
            ],
            "createdOn": "2022-08-29T03:52:32.866Z",
            "updatedOn": "2022-08-29T03:52:32.866Z"
        }
    ]
}

Added response fields

The following fields are added to the response body. Other response fields are identical to the parameters you specified in the request.

FieldDescription
idThe Tracker ID, in the form of a unique integer string.
createdOnTimestamp when the Tracker was created.
updatedOnTimestamp when the Tracker was updated. Identical timestamps indicate no update.

Did this page help you?