> ## 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 Interaction Stats

> Get talk-ratio, interactivity, and other call interaction stats for Gong users over a date range. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get talk-ratio, interactivity, and other call interaction stats for Gong users over a date range.

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

## 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_interaction_stats',
  {
    "filter": {
      "fromDate": "2026-01-15T12:00:00Z",
      "toDate": "2026-01-15T12:00:00Z"
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_interaction_stats --input '{
  "filter": {
    "fromDate": "2026-01-15T12:00:00Z",
    "toDate": "2026-01-15T12:00:00Z"
  }
}' --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",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "peopleInteractionStats": [
      {
        "userId": "user_123",
        "userEmailAddress": "jane.doe@example.com",
        "personInteractionStats": [
          {}
        ]
      }
    ]
  }
}
```

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

## Input reference

Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.cursor` | `string` | No | — | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. |
| `payload.filter` | `object` | Yes | — | Filter parameters. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.",
    "properties": {
      "cursor": {
        "type": "string",
        "description": "When paging is needed, provide the value supplied by the previous API call to bring the following page of records."
      },
      "filter": {
        "type": "object",
        "description": "Filter parameters.",
        "properties": {
          "fromDate": {
            "type": "string",
            "description": "The date (in the company's time zone) from which to list a user's activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD."
          },
          "toDate": {
            "type": "string",
            "description": "The date (in the company's time zone) until which to list a user's activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD."
          },
          "createdFromDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "createdToDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "userIds": {
            "type": "array",
            "description": "Set of Gong's unique numeric identifiers for the users (up to 20 digits).",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "fromDate",
          "toDate"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "filter"
    ],
    "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.records` | `object` | No | — | Information about the number of records that match the requested filter. |
| `result.data.records.totalRecords` | `integer` | No | — | Total number of records. Format: `int32`. |
| `result.data.records.currentPageSize` | `integer` | No | — | Number of records in the current page. Format: `int32`. |
| `result.data.records.currentPageNumber` | `integer` | No | — | Current page number. Format: `int32`. |
| `result.data.records.cursor` | `string` | No | — | Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records. |
| `result.data.peopleInteractionStats` | `array` | No | — | A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'. |
| `result.data.peopleInteractionStats[].userId` | `string` | No | — | Gong's unique numeric identifier for the user (up to 20 digits). |
| `result.data.peopleInteractionStats[].userEmailAddress` | `string` | No | — | The email address of the Gong user. |
| `result.data.peopleInteractionStats[].personInteractionStats` | `array` | No | — | — |
| `result.data.peopleInteractionStats[].personInteractionStats[].name` | `string` | No | — | Stat name |
| `result.data.peopleInteractionStats[].personInteractionStats[].value` | `number` | No | — | Stat measurement (Can be either a double or integer) Format: `double`. |
| `result.data.fromDateTime` | `string` | No | — | The date and time 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, when the list of results starts. |
| `result.data.toDateTime` | `string` | No | — | The date and time 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, when the list of results ends. |
| `result.data.timeZone` | `string` | No | — | The company's defined timezone in Gong. |
| `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."
          },
          "records": {
            "type": "object",
            "description": "Information about the number of records that match the requested filter.",
            "properties": {
              "totalRecords": {
                "type": "integer",
                "description": "Total number of records.",
                "format": "int32"
              },
              "currentPageSize": {
                "type": "integer",
                "description": "Number of records in the current page.",
                "format": "int32"
              },
              "currentPageNumber": {
                "type": "integer",
                "description": "Current page number.",
                "format": "int32"
              },
              "cursor": {
                "type": "string",
                "description": "Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records."
              }
            },
            "additionalProperties": false
          },
          "peopleInteractionStats": {
            "type": "array",
            "description": "A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'.",
            "items": {
              "type": "object",
              "description": "A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'.",
              "properties": {
                "userId": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the user (up to 20 digits)."
                },
                "userEmailAddress": {
                  "type": "string",
                  "description": "The email address of the Gong user."
                },
                "personInteractionStats": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Stat name"
                      },
                      "value": {
                        "type": "number",
                        "description": "Stat measurement (Can be either a double or integer)",
                        "format": "double"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "fromDateTime": {
            "type": "string",
            "description": "The date and time 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, when the list of results starts."
          },
          "toDateTime": {
            "type": "string",
            "description": "The date and time 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, when the list of results ends."
          },
          "timeZone": {
            "type": "string",
            "description": "The company's defined timezone in Gong."
          }
        },
        "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.