Documentation Index

Fetch the complete documentation index at: https://help.gong.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve scorecards details (/v2/settings/scorecards)

Prev Next
Get
/v2/settings/scorecards

Retrieve all the scorecards within the Gong system.

Required authorizaton scope: 'api:settings:scorecards:read'.

Responses
200

Successful response

Expand All
object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
scorecards
Array of object (Scorecard)

A list, in which each item contains one scorecard.

object

A list, in which each item contains one scorecard.

scorecardId
integer (int64)

The identifier of the scorecard.

Example6843152929075440000
scorecardName
string

Scorecard name.

ExampleSDR Call Scorecard
workspaceId
integer (int64)

Scorecard workspaceId.

Example623457276584334
enabled
boolean

If the scorecard is enabled or not.

Exampletrue
updaterUserId
integer (int64)

The user Id of the team member that updated the scorecard.

Example234599484848423
created
string (date-time)

The date and time when the scorecard 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.

Example2018-02-17T10:30:00Z
updated
string (date-time)

The date and time when the scorecard was 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.

Example2018-02-19T10:30:00Z
reviewMethod
string

The method used to review the scorecard.

Valid values[ "AUTOMATIC", "MANUAL" ]
questions
Array of object (Question)

The questions in the scorecard.

object

The questions in the scorecard.

questionId
integer (int64)

The identifier for the question.

questionRevisionId
integer (int64)

The identifier for the revision version of the question.

Example43955224753211110
questionText
string

The question's text.

ExampleHow do you evaluate the SDR's overall performance in the call?
isOverall
boolean

If the question is the main overall question.

Examplefalse
questionType
string

The type of question.

ExampleRANGE
answerGuide
string

The guide for answering the question.

ExampleAnswer is in the small talk
minRange
integer (int32)

The minimum value that can be selected in the answer. Null for questions with no range.

Example0
maxRange
integer (int32)

The maximum value that can be selected in the answer. Null for questions with no range.

Example50
answerOptions
Array of object (QuestionOption)

The answer options in case of multi-select or single-select type question. Null otherwise.

object

The answer options in case of multi-select or single-select type question. Null otherwise.

id
integer (int32)

The identifier of the option.

Example1
text
string

The option’s text.

ExampleThe SDR did not mention the product
400

Malformed request

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
401

Access denied

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
404

Scorecards not found

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
429

API request limit exceeded

Headers
Retry-After
integer
Number of seconds to wait before making a new request.
object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
500

Failed to complete the operation due to an unexpected error

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string