> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gong: List Trackers

> List the keyword trackers set up in Gong, for all workspaces or one. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the keyword trackers set up in Gong, for all workspaces or one.

> [!NOTE]
>
> Tool ID: `gong_list_trackers`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_list_trackers',
  {
    "workspaceId": "workspace_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_trackers --input '{
  "workspaceId": "workspace_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "keywordTrackers": [
      {
        "trackerId": "tracker_123",
        "trackerName": "Example",
        "workspaceId": "workspace_123"
      }
    ]
  }
}
```

Use `deepline describe gong_list_trackers --json` for the latest machine-readable contract.

## Input reference

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.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceId` | `string` | No | — | The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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.",
    "properties": {
      "workspaceId": {
        "type": "string",
        "description": "The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.requestId` | `string` | No | — | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. |
| `result.data.keywordTrackers` | `array` | No | — | A list of keyword trackers. |
| `result.data.keywordTrackers[].trackerId` | `string` | No | — | The unique identifier of the tracker. |
| `result.data.keywordTrackers[].trackerName` | `string` | No | — | The name of the tracker. |
| `result.data.keywordTrackers[].workspaceId` | `string` | No | — | The id of the workspace the tracker is in. |
| `result.data.keywordTrackers[].languageKeywords` | `array` | No | — | The words and phrases defined for the tracker. Each languagueKeywords object contains the words and phrases defined in the specified language. |
| `result.data.keywordTrackers[].languageKeywords[].language` | `string` | No | — | 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. |
| `result.data.keywordTrackers[].languageKeywords[].keywords` | `array` | No | — | A list of words and phrases in the specified language. |
| `result.data.keywordTrackers[].languageKeywords[].includeRelatedForms` | `boolean` | No | — | When true the tracker identifies words in different forms, for example, if the keyword is "organize", "organized" and "organizes" are also included. |
| `result.data.keywordTrackers[].affiliation` | `string` | No | — | Sets whether to track the keywords when said by people affiliated to a specific company. Options are: "Anyone", "Company", "NonCompany". |
| `result.data.keywordTrackers[].partOfQuestion` | `boolean` | No | — | When true, only looks for the keywords when they are part of a question. |
| `result.data.keywordTrackers[].saidAt` | `string` | No | — | 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. |
| `result.data.keywordTrackers[].saidAtInterval` | `integer` | No | — | 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. Format: `int32`. |
| `result.data.keywordTrackers[].saidAtUnit` | `string` | No | — | Sets whether the time to look for keywords is in minutes or a percentage of the call duration (according to the saidAt setting). |
| `result.data.keywordTrackers[].saidInTopics` | `array` | No | — | Sets the topics in the call the tracker terms should be picked up in. |
| `result.data.keywordTrackers[].filterQuery` | `string` | No | — | 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"] } ] } |
| `result.data.keywordTrackers[].created` | `string` | No | — | 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. |
| `result.data.keywordTrackers[].creatorUserId` | `string` | No | — | The Id of the team member who created the tracker. Null when the tracker is built-in. |
| `result.data.keywordTrackers[].updated` | `string` | No | — | 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. |
| `result.data.keywordTrackers[].updaterUserId` | `string` | No | — | The Id of the team member who updated the tracker. Null when the tracker is built-in. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
          },
          "keywordTrackers": {
            "type": "array",
            "description": "A list of keyword trackers.",
            "items": {
              "type": "object",
              "description": "The definition of a tracker.",
              "properties": {
                "trackerId": {
                  "type": "string",
                  "description": "The unique identifier of the tracker."
                },
                "trackerName": {
                  "type": "string",
                  "description": "The name of the tracker."
                },
                "workspaceId": {
                  "type": "string",
                  "description": "The id of the workspace the tracker is in."
                },
                "languageKeywords": {
                  "type": "array",
                  "description": "The words and phrases defined for the tracker. Each languagueKeywords object contains the words and phrases defined in the specified language.",
                  "items": {
                    "type": "object",
                    "description": "The tracker keywords definition.",
                    "properties": {
                      "language": {
                        "type": "string",
                        "description": "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."
                      },
                      "keywords": {
                        "type": "array",
                        "description": "A list of words and phrases in the specified language.",
                        "items": {
                          "type": "string"
                        }
                      },
                      "includeRelatedForms": {
                        "type": "boolean",
                        "description": "When true the tracker identifies words in different forms, for example, if the keyword is \"organize\", \"organized\" and \"organizes\" are also included."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "affiliation": {
                  "type": "string",
                  "description": "Sets whether to track the keywords when said by people affiliated to a specific company. Options are: \"Anyone\", \"Company\", \"NonCompany\"."
                },
                "partOfQuestion": {
                  "type": "boolean",
                  "description": "When true, only looks for the keywords when they are part of a question."
                },
                "saidAt": {
                  "type": "string",
                  "description": "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."
                },
                "saidAtInterval": {
                  "type": "integer",
                  "description": "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.",
                  "format": "int32"
                },
                "saidAtUnit": {
                  "type": "string",
                  "description": "Sets whether the time to look for keywords is in minutes or a percentage of the call duration (according to the saidAt setting)."
                },
                "saidInTopics": {
                  "type": "array",
                  "description": "Sets the topics in the call the tracker terms should be picked up in.",
                  "items": {
                    "type": "string"
                  }
                },
                "filterQuery": {
                  "type": "string",
                  "description": "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\"] } ] }"
                },
                "created": {
                  "type": "string",
                  "description": "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."
                },
                "creatorUserId": {
                  "type": "string",
                  "description": "The Id of the team member who created the tracker. Null when the tracker is built-in."
                },
                "updated": {
                  "type": "string",
                  "description": "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."
                },
                "updaterUserId": {
                  "type": "string",
                  "description": "The Id of the team member who updated the tracker. Null when the tracker is built-in."
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Gong provider guide](https://deepline.com/docs/providers/gong/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.