Retrieves details of all keyword trackers in the system or in a given workspace.
When accessed through a Bearer token authorization method, this endpoint requires the 'api:settings:trackers:read' scope.
The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
A list of keyword trackers.
The definition of a tracker.
The unique identifier of the tracker.
The name of the tracker.
The id of the workspace the tracker is in.
The words and phrases defined for the tracker. Each languagueKeywords object contains the words and phrases defined in the specified language.
The tracker keywords definition.
The ISO 639-2/B language code for the language the keywords are in. When set to "mul" (ISO 639-2/B code for multiple languages), the keywords are relevant for all languages.
A list of words and phrases in the specified language.
When true the tracker identifies words in different forms, for example, if the keyword is "organize", "organized" and "organizes" are also included.
Sets whether to track the keywords when said by people affiliated to a specific company. Options are: "Anyone", "Company", "NonCompany".
When true, only looks for the keywords when they are part of a question.
Sets whether the words and phrases are tracked at the beginning, end or anytime in a call. Options are: "Anytime", "First", or "Last". For “First” and “Last” see the saidAtInterval and saidAtUnit fields to see how long to track the keywords for.
Sets the period of time to check if the words or phrases came up in the call (according to the saidAt setting). This can be either minutes or percent depending on the value in the saidAtUnit parameter.
Sets whether the time to look for keywords is in minutes or a percentage of the call duration (according to the saidAt setting).
Sets the topics in the call the tracker terms should be picked up in.
A filter that defines which calls to include when searching for the keyword tracker. The filter is in JSON and is in the URL of the search page. Example: a filter for all outbound calls { "type": "And", "filters": [ { "type": "CallDirection", "terms": ["OUTBOUND"] } ] }
Sets the date and time the tracker was created, in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.
The Id of the team member who created the tracker. Null when the tracker is built-in.
The date and time the tracker settings were last updated, in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.
The Id of the team member who updated the tracker. Null when the tracker is built-in.
Malformed request
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Access denied
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Workspace not found
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
API request limit exceeded
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Failed to complete the operation due to an unexpected error
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.