> ## 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 Answered Scorecards
> Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards).
Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards).
> [!NOTE]
>
> Tool ID: `gong_list_answered_scorecards`
## 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_answered_scorecards',
{
"filter": {
"callFromDate": "2026-01-15T12:00:00Z",
"callToDate": "2026-01-15T12:00:00Z",
"reviewFromDate": "2026-01-15T12:00:00Z"
}
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_answered_scorecards --input '{
"filter": {
"callFromDate": "2026-01-15T12:00:00Z",
"callToDate": "2026-01-15T12:00:00Z",
"reviewFromDate": "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
},
"answeredScorecards": [
{
"answeredScorecardId": 123,
"scorecardId": 123,
"scorecardName": "Example"
}
]
}
}
```
Use `deepline describe gong_list_answered_scorecards --json` for the latest machine-readable contract.
## Input reference
Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.
| 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. |
Show raw input schema
### Input JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.",
"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": {
"callFromDate": {
"type": "string",
"description": "The date (in the company's time zone) of the call from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest recorded call."
},
"callToDate": {
"type": "string",
"description": "The date (in the company's time zone) of the call until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest recorded call."
},
"reviewFromDate": {
"type": "string",
"description": "The review date (in the company's time zone) from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest reviewed call."
},
"reviewToDate": {
"type": "string",
"description": "The review date (in the company's time zone) until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest reviewed call."
},
"reviewMethod": {
"type": "string",
"description": "Select whether to return scorecards that have been reviewed manually, automatically, or both. Default value: MANUAL",
"enum": [
"AUTOMATIC",
"MANUAL",
"BOTH"
]
},
"reviewedUserIds": {
"type": "array",
"description": "List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter.",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"scorecardIds": {
"type": "array",
"description": "List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter.",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"filter"
],
"additionalProperties": false
}
```
## 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.answeredScorecards` | `array` | No | — | A list, in which each item contains one answered scorecard. |
| `result.data.answeredScorecards[].answeredScorecardId` | `integer` | No | — | The identifier of the answer of the scorecard. Format: `int64`. |
| `result.data.answeredScorecards[].scorecardId` | `integer` | No | — | The identifier of the scorecard. Format: `int64`. |
| `result.data.answeredScorecards[].scorecardName` | `string` | No | — | Scorecard name. |
| `result.data.answeredScorecards[].callId` | `integer` | No | — | Gong's unique numeric identifier for the call (up to 20 digits). Format: `int64`. |
| `result.data.answeredScorecards[].callStartTime` | `string` | No | — | The date and time when the call was recorded 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. Format: `date-time`. |
| `result.data.answeredScorecards[].reviewedUserId` | `integer` | No | — | The user Id of the team member being reviewed, who hosted the call. Format: `int64`. |
| `result.data.answeredScorecards[].reviewerUserId` | `integer` | No | — | The user Id of the team member who answered the scorecard for the call, if the scorecard reviewMethod is AUTOMATIC this id would be null Format: `int64`. |
| `result.data.answeredScorecards[].reviewMethod` | `"AUTOMATIC" \| "MANUAL"` | No | — | The method used to review the scorecard. Allowed: `AUTOMATIC`, `MANUAL`. |
| `result.data.answeredScorecards[].editorUserId` | `integer` | No | — | The user Id of the last team member to edit the answer. Null when no-one has edited the scorecard, or when the original team member to fill in the scorecard has edited the answers. Format: `int64`. |
| `result.data.answeredScorecards[].reviewTime` | `string` | No | — | The date and time when the review was completed and published 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. Format: `date-time`. |
| `result.data.answeredScorecards[].visibilityType` | `"PUBLIC" \| "PRIVATE" \| "OPT_IN_USERS" \| "MANAGERS" \| "MANAGERS_AND_REVIEWEE"` | No | — | Allowed: `PUBLIC`, `PRIVATE`, `OPT_IN_USERS`, `MANAGERS`, `MANAGERS_AND_REVIEWEE`. |
| `result.data.answeredScorecards[].answers` | `array` | No | — | The answers in the answered scorecard. |
| `result.data.answeredScorecards[].answers[].questionId` | `integer` | No | — | The identifier of the question. Format: `int64`. |
| `result.data.answeredScorecards[].answers[].questionRevisionId` | `integer` | No | — | The identifier of the revision version of the question. Format: `int64`. |
| `result.data.answeredScorecards[].answers[].isOverall` | `boolean` | No | — | If the question is the main overall question or not. |
| `result.data.answeredScorecards[].answers[].score` | `integer` | No | — | Score between 1 to 50, if answered. Null otherwise. Format: `int32`. |
| `result.data.answeredScorecards[].answers[].answerText` | `string` | No | — | The answer's text, if answered. Null otherwise. |
| `result.data.answeredScorecards[].answers[].notApplicable` | `boolean` | No | — | If the question is irrelevant for the call. |
| `result.data.answeredScorecards[].answers[].selectedOptions` | `array` | No | — | The identifier of the options selected. Null otherwise |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### 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
},
"answeredScorecards": {
"type": "array",
"description": "A list, in which each item contains one answered scorecard.",
"items": {
"type": "object",
"description": "A list, in which each item contains one answered scorecard.",
"properties": {
"answeredScorecardId": {
"type": "integer",
"description": "The identifier of the answer of the scorecard.",
"format": "int64"
},
"scorecardId": {
"type": "integer",
"description": "The identifier of the scorecard.",
"format": "int64"
},
"scorecardName": {
"type": "string",
"description": "Scorecard name."
},
"callId": {
"type": "integer",
"description": "Gong's unique numeric identifier for the call (up to 20 digits).",
"format": "int64"
},
"callStartTime": {
"type": "string",
"description": "The date and time when the call was recorded 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.",
"format": "date-time"
},
"reviewedUserId": {
"type": "integer",
"description": "The user Id of the team member being reviewed, who hosted the call.",
"format": "int64"
},
"reviewerUserId": {
"type": "integer",
"description": "The user Id of the team member who answered the scorecard for the call, if the scorecard reviewMethod is AUTOMATIC this id would be null",
"format": "int64"
},
"reviewMethod": {
"type": "string",
"description": "The method used to review the scorecard.",
"enum": [
"AUTOMATIC",
"MANUAL"
]
},
"editorUserId": {
"type": "integer",
"description": "The user Id of the last team member to edit the answer. Null when no-one has edited the scorecard, or when the original team member to fill in the scorecard has edited the answers.",
"format": "int64"
},
"reviewTime": {
"type": "string",
"description": "The date and time when the review was completed and published 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.",
"format": "date-time"
},
"visibilityType": {
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE",
"OPT_IN_USERS",
"MANAGERS",
"MANAGERS_AND_REVIEWEE"
]
},
"answers": {
"type": "array",
"description": "The answers in the answered scorecard.",
"items": {
"type": "object",
"description": "The answers in the answered scorecard.",
"properties": {
"questionId": {
"type": "integer",
"description": "The identifier of the question.",
"format": "int64"
},
"questionRevisionId": {
"type": "integer",
"description": "The identifier of the revision version of the question.",
"format": "int64"
},
"isOverall": {
"type": "boolean",
"description": "If the question is the main overall question or not."
},
"score": {
"type": "integer",
"description": "Score between 1 to 50, if answered. Null otherwise.",
"format": "int32"
},
"answerText": {
"type": "string",
"description": "The answer's text, if answered. Null otherwise."
},
"notApplicable": {
"type": "boolean",
"description": "If the question is irrelevant for the call."
},
"selectedOptions": {
"type": "array",
"description": "The identifier of the options selected. Null otherwise",
"items": {
"type": "string",
"description": "The identifier of the options selected. Null otherwise"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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.