> ## 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 Logs

> Retrieve logs data by type and time range (/v2/logs). Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve logs data by type and time range (/v2/logs).

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

## 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_logs',
  {
    "logType": "AccessLog",
    "fromDateTime": "2026-01-15T12:00:00Z"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_logs --input '{
  "logType": "AccessLog",
  "fromDateTime": "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
    },
    "logEntries": [
      {
        "userId": "user_123",
        "userEmailAddress": "jane.doe@example.com",
        "userFullName": "Example"
      }
    ]
  }
}
```

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

## Input reference

List log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.logType` | `"AccessLog" \| "UserActivityLog" \| "UserCallPlay" \| "ExternallySharedCallAccess" \| "ExternallySharedCallPlay"` | Yes | — | Type of logs requested. Allowed: `AccessLog`, `UserActivityLog`, `UserCallPlay`, `ExternallySharedCallAccess`, `ExternallySharedCallPlay`. |
| `payload.fromDateTime` | `string` | Yes | — | The time from which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). |
| `payload.toDateTime` | `string` | No | — | The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). if not specified, the logs end with the latest recorded log. |
| `payload.cursor` | `string` | No | — | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.",
    "properties": {
      "logType": {
        "type": "string",
        "description": "Type of logs requested.",
        "enum": [
          "AccessLog",
          "UserActivityLog",
          "UserCallPlay",
          "ExternallySharedCallAccess",
          "ExternallySharedCallPlay"
        ]
      },
      "fromDateTime": {
        "type": "string",
        "description": "The time from which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."
      },
      "toDateTime": {
        "type": "string",
        "description": "The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the logs end with the latest recorded log."
      },
      "cursor": {
        "type": "string",
        "description": "When paging is needed, provide the value supplied by the previous API call to bring the following page of records."
      }
    },
    "required": [
      "logType",
      "fromDateTime"
    ],
    "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.logEntries` | `array` | No | — | A list, in which each item specifies one log. |
| `result.data.logEntries[].userId` | `string` | No | — | Gong's unique numeric identifier for the user (up to 20 digits), if available. |
| `result.data.logEntries[].userEmailAddress` | `string` | No | — | The email address of the user, if available. |
| `result.data.logEntries[].userFullName` | `string` | No | — | The full name of the user, if available. |
| `result.data.logEntries[].impersonatorUserId` | `string` | No | — | Gong's unique numeric identifier for the impersonating user (up to 20 digits), if available. |
| `result.data.logEntries[].impersonatorEmailAddress` | `string` | No | — | The email address of the impersonating user, if available. |
| `result.data.logEntries[].impersonatorFullName` | `string` | No | — | The full name of the impersonating user, if available. |
| `result.data.logEntries[].impersonatorCompanyId` | `string` | No | — | Gong's unique numeric identifier for the impersonating user's company id (up to 20 digits), if available. |
| `result.data.logEntries[].eventTime` | `string` | No | — | The time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). when log was created. |
| `result.data.logEntries[].logRecord` | `record` | No | — | The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log. |
| `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
          },
          "logEntries": {
            "type": "array",
            "description": "A list, in which each item specifies one log.",
            "items": {
              "type": "object",
              "description": "A list, in which each item specifies one log.",
              "properties": {
                "userId": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the user (up to 20 digits), if available."
                },
                "userEmailAddress": {
                  "type": "string",
                  "description": "The email address of the user, if available."
                },
                "userFullName": {
                  "type": "string",
                  "description": "The full name of the user, if available."
                },
                "impersonatorUserId": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the impersonating user (up to 20 digits), if available."
                },
                "impersonatorEmailAddress": {
                  "type": "string",
                  "description": "The email address of the impersonating user, if available."
                },
                "impersonatorFullName": {
                  "type": "string",
                  "description": "The full name of the impersonating user, if available."
                },
                "impersonatorCompanyId": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the impersonating user's company id (up to 20 digits), if available."
                },
                "eventTime": {
                  "type": "string",
                  "description": "The time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); when log was created."
                },
                "logRecord": {
                  "type": "object",
                  "description": "The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log.",
                  "additionalProperties": {
                    "type": "object",
                    "description": "The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log."
                  }
                }
              },
              "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.