Integrate Gong into your workflow. Access call recordings, transcripts, user data, activity stats, scorecards, trackers, library content, coaching metrics, and more via the Gong API.
Retrieve call data by date range from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
fromDateTime | string | Oui | Start date/time in ISO-8601 format (e.g., 2024-01-01T00:00:00Z) |
toDateTime | string | Non | End date/time in ISO-8601 format (e.g., 2024-01-31T23:59:59Z). If omitted, lists calls up to the most recent. |
cursor | string | Non | Pagination cursor from a previous response |
workspaceId | string | Non | Gong workspace ID to filter calls |
| Paramètre | Type | Description |
|---|
calls | array | List of calls matching the date range |
↳ id | string | Gong's unique numeric identifier for the call |
↳ title | string | Call title |
↳ scheduled | string | Scheduled call time in ISO-8601 format |
↳ started | string | Recording start time in ISO-8601 format |
↳ duration | number | Call duration in seconds |
↳ direction | string | Call direction (Inbound/Outbound) |
↳ system | string | Communication platform used (e.g., Outreach) |
↳ scope | string | Call scope: 'Internal', 'External', or 'Unknown' |
↳ media | string | Media type (e.g., Video) |
↳ language | string | Language code in ISO-639-2B format |
↳ url | string | URL to the call in the Gong web app |
↳ primaryUserId | string | Host team member identifier |
↳ workspaceId | string | Workspace identifier |
↳ sdrDisposition | string | SDR disposition classification |
↳ clientUniqueId | string | Call identifier from the origin recording system |
↳ customData | string | Metadata provided during call creation |
↳ purpose | string | Call purpose |
↳ meetingUrl | string | Web conference provider URL |
↳ isPrivate | boolean | Whether the call is private |
↳ calendarEventId | string | Calendar event identifier |
cursor | string | Pagination cursor for the next page |
totalRecords | number | Total number of records matching the filter |
Upload call metadata to Gong and let Gong pull the media from a URL.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
clientUniqueId | string | Oui | Unique call ID from the source telephony or recording system |
actualStart | string | Oui | Actual call start time in ISO-8601 format |
primaryUser | string | Oui | Gong user ID for the call's host or owner |
parties | json | Oui | Array of call parties, with at least the primary user included |
direction | string | Oui | Call direction: Inbound, Outbound, Conference, or Unknown |
downloadMediaUrl | string | Oui | URL where Gong can download the call media file |
title | string | Non | Human-readable call title |
workspaceId | string | Non | Optional Gong workspace ID |
disposition | string | Non | Optional call disposition |
purpose | string | Non | Optional call purpose |
context | json | Non | Optional CRM context array for the call |
callProviderCode | string | Non | Optional conferencing or telephony provider code |
| Paramètre | Type | Description |
|---|
callId | string | Gong's unique numeric identifier for the created call |
requestId | string | Gong request reference ID for troubleshooting |
url | string | URL to the created call in the Gong web app |
Retrieve detailed data for a specific call from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
callId | string | Oui | The Gong call ID to retrieve |
| Paramètre | Type | Description |
|---|
id | string | Gong's unique numeric identifier for the call |
title | string | Call title |
url | string | URL to the call in the Gong web app |
scheduled | string | Scheduled call time in ISO-8601 format |
started | string | Recording start time in ISO-8601 format |
duration | number | Call duration in seconds |
direction | string | Call direction (Inbound/Outbound) |
system | string | Communication platform used (e.g., Outreach) |
scope | string | Call scope: 'Internal', 'External', or 'Unknown' |
media | string | Media type (e.g., Video) |
language | string | Language code in ISO-639-2B format |
primaryUserId | string | Host team member identifier |
workspaceId | string | Workspace identifier |
sdrDisposition | string | SDR disposition classification |
clientUniqueId | string | Call identifier from the origin recording system |
customData | string | Metadata provided during call creation |
purpose | string | Call purpose |
meetingUrl | string | Web conference provider URL |
isPrivate | boolean | Whether the call is private |
calendarEventId | string | Calendar event identifier |
Retrieve transcripts of calls from Gong by call IDs or date range.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
callIds | string | Non | Comma-separated list of call IDs to retrieve transcripts for |
fromDateTime | string | Non | Start date/time filter in ISO-8601 format |
toDateTime | string | Non | End date/time filter in ISO-8601 format |
workspaceId | string | Non | Gong workspace ID to filter calls |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
callTranscripts | array | List of call transcripts with speaker turns and sentences |
↳ callId | string | Gong's unique numeric identifier for the call |
↳ transcript | array | List of monologues in the call |
↳ speakerId | string | Unique ID of the speaker, cross-reference with parties |
↳ topic | string | Name of the topic being discussed |
↳ sentences | array | List of sentences spoken in the monologue |
↳ start | number | Start time of the sentence in milliseconds from call start |
↳ end | number | End time of the sentence in milliseconds from call start |
↳ text | string | The sentence text |
cursor | string | Pagination cursor for the next page |
Retrieve detailed call data including trackers, topics, highlights, and AI spotlight content (brief, outline, key points, call outcome) from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
callIds | string | Non | Comma-separated list of call IDs to retrieve detailed data for |
fromDateTime | string | Non | Start date/time filter in ISO-8601 format |
toDateTime | string | Non | End date/time filter in ISO-8601 format |
workspaceId | string | Non | Gong workspace ID to filter calls |
primaryUserIds | string | Non | Comma-separated list of user IDs to filter calls by host |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
calls | array | List of detailed call objects with metadata, content, interaction stats, and collaboration data |
↳ metaData | object | Call metadata (same fields as CallBasicData) |
↳ id | string | Call ID |
↳ title | string | Call title |
↳ scheduled | string | Scheduled time in ISO-8601 |
↳ started | string | Start time in ISO-8601 |
↳ duration | number | Duration in seconds |
↳ direction | string | Call direction |
↳ system | string | Communication platform |
↳ scope | string | Internal/External/Unknown |
↳ media | string | Media type |
↳ language | string | Language code (ISO-639-2B) |
↳ url | string | Gong web app URL |
↳ primaryUserId | string | Host user ID |
↳ workspaceId | string | Workspace ID |
↳ sdrDisposition | string | SDR disposition |
↳ clientUniqueId | string | Origin system call ID |
↳ customData | string | Custom metadata |
↳ purpose | string | Call purpose |
↳ meetingUrl | string | Meeting URL |
↳ isPrivate | boolean | Whether call is private |
↳ calendarEventId | string | Calendar event ID |
↳ context | array | Links to external systems (CRM, Dialer, etc.) |
↳ system | string | External system name (e.g., Salesforce) |
↳ objects | array | List of objects within the external system |
↳ parties | array | List of call participants |
↳ id | string | Unique participant ID in the call |
↳ name | string | Participant name |
↳ emailAddress | string | Email address |
↳ title | string | Job title |
↳ phoneNumber | string | Phone number |
↳ speakerId | string | Speaker ID for transcript cross-reference |
↳ userId | string | Gong user ID |
↳ affiliation | string | Company or non-company |
↳ methods | array | Whether invited or attended |
↳ context | array | Links to external systems for this party |
↳ content | object | Call content data |
↳ brief | string | AI-generated brief summary of the call (Call Spotlight) |
↳ outline | array | AI-generated call outline sections |
↳ section | string | Outline section name |
↳ startTime | number | Section start in seconds from call start |
↳ duration | number | Section duration in seconds |
↳ keyPoints | array | AI-generated key points of the call |
↳ text | string | Key point text |
↳ callOutcome | object | AI-determined call outcome (Call Spotlight) |
↳ id | string | Outcome category ID |
↳ category | string | Outcome category name |
↳ name | string | Outcome name |
↳ structure | array | Call agenda parts |
↳ name | string | Agenda name |
↳ duration | number | Duration of this part in seconds |
↳ topics | array | Topics and their durations |
↳ name | string | Topic name (e.g., Pricing) |
↳ duration | number | Time spent on topic in seconds |
↳ trackers | array | Trackers found in the call |
↳ id | string | Tracker ID |
↳ name | string | Tracker name |
↳ count | number | Number of occurrences |
↳ type | string | Keyword or Smart |
↳ occurrences | array | Details for each occurrence |
↳ speakerId | string | Speaker who said it |
↳ startTime | number | Seconds from call start |
↳ phrases | array | Per-phrase occurrence counts |
↳ phrase | string | Specific phrase |
↳ count | number | Occurrences of this phrase |
↳ occurrences | array | Details per occurrence |
↳ highlights | array | AI-generated highlights including next steps, action items, and key moments |
↳ title | string | Title of the highlight |
↳ interaction | object | Interaction statistics |
↳ interactionStats | array | Interaction stats per user |
↳ userId | string | Gong user ID |
↳ userEmailAddress | string | User email |
↳ personInteractionStats | array | Stats list (Longest Monologue, Interactivity, Patience, etc.) |
↳ name | string | Stat name |
↳ value | number | Stat value |
↳ speakers | array | Talk duration per speaker |
↳ id | string | Participant ID |
↳ userId | string | Gong user ID |
↳ talkTime | number | Talk duration in seconds |
↳ video | array | Video statistics |
↳ name | string | Segment type: Browser, Presentation, WebcamPrimaryUser, WebcamNonCompany, Webcam |
↳ duration | number | Total segment duration in seconds |
↳ questions | object | Question counts |
↳ companyCount | number | Questions by company speakers |
↳ nonCompanyCount | number | Questions by non-company speakers |
↳ collaboration | object | Collaboration data |
↳ publicComments | array | Public comments on the call |
↳ id | string | Comment ID |
↳ commenterUserId | string | Commenter user ID |
↳ comment | string | Comment text |
↳ posted | string | Posted time in ISO-8601 |
↳ audioStartTime | number | Seconds from call start the comment refers to |
↳ audioEndTime | number | Seconds from call start the comment end refers to |
↳ duringCall | boolean | Whether the comment was posted during the call |
↳ inReplyTo | string | ID of original comment if this is a reply |
↳ media | object | Media download URLs (available for 8 hours) |
↳ audioUrl | string | Audio download URL |
↳ videoUrl | string | Video download URL |
cursor | string | Pagination cursor for the next page |
List all users in your Gong account.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
cursor | string | Non | Pagination cursor from a previous response |
includeAvatars | string | Non | Whether to include avatar URLs (true/false) |
| Paramètre | Type | Description |
|---|
users | array | List of Gong users |
↳ id | string | Unique numeric user ID (up to 20 digits) |
↳ emailAddress | string | User email address |
↳ created | string | User creation timestamp (ISO-8601) |
↳ active | boolean | Whether the user is active |
↳ emailAliases | array | Alternative email addresses for the user |
↳ trustedEmailAddress | string | Trusted email address for the user |
↳ firstName | string | First name |
↳ lastName | string | Last name |
↳ title | string | Job title |
↳ phoneNumber | string | Phone number |
↳ extension | string | Phone extension number |
↳ personalMeetingUrls | array | Personal meeting URLs |
↳ settings | object | User settings |
↳ webConferencesRecorded | boolean | Whether web conferences are recorded |
↳ preventWebConferenceRecording | boolean | Whether web conference recording is prevented |
↳ telephonyCallsImported | boolean | Whether telephony calls are imported |
↳ emailsImported | boolean | Whether emails are imported |
↳ preventEmailImport | boolean | Whether email import is prevented |
↳ nonRecordedMeetingsImported | boolean | Whether non-recorded meetings are imported |
↳ gongConnectEnabled | boolean | Whether Gong Connect is enabled |
↳ managerId | string | Manager user ID |
↳ meetingConsentPageUrl | string | Meeting consent page URL |
↳ spokenLanguages | array | Languages spoken by the user |
↳ language | string | Language code |
↳ primary | boolean | Whether this is the primary language |
cursor | string | Pagination cursor for the next page |
totalRecords | number | Total number of user records |
currentPageSize | number | Number of records in the current page |
currentPageNumber | number | Current page number |
Retrieve details for a specific user from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
userId | string | Oui | The Gong user ID to retrieve |
| Paramètre | Type | Description |
|---|
id | string | Unique numeric user ID (up to 20 digits) |
emailAddress | string | User email address |
created | string | User creation timestamp (ISO-8601) |
active | boolean | Whether the user is active |
emailAliases | array | Alternative email addresses for the user |
trustedEmailAddress | string | Trusted email address for the user |
firstName | string | First name |
lastName | string | Last name |
title | string | Job title |
phoneNumber | string | Phone number |
extension | string | Phone extension number |
personalMeetingUrls | array | Personal meeting URLs |
settings | object | User settings |
↳ webConferencesRecorded | boolean | Whether web conferences are recorded |
↳ preventWebConferenceRecording | boolean | Whether web conference recording is prevented |
↳ telephonyCallsImported | boolean | Whether telephony calls are imported |
↳ emailsImported | boolean | Whether emails are imported |
↳ preventEmailImport | boolean | Whether email import is prevented |
↳ nonRecordedMeetingsImported | boolean | Whether non-recorded meetings are imported |
↳ gongConnectEnabled | boolean | Whether Gong Connect is enabled |
managerId | string | Manager user ID |
meetingConsentPageUrl | string | Meeting consent page URL |
spokenLanguages | array | Languages spoken by the user |
↳ language | string | Language code |
↳ primary | boolean | Whether this is the primary language |
Retrieve aggregated activity statistics for users by date range from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
userIds | string | Non | Comma-separated list of Gong user IDs (up to 20 digits each) |
fromDate | string | Oui | Start date in YYYY-MM-DD format (inclusive, in company timezone) |
toDate | string | Oui | End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
usersActivity | array | Aggregated activity statistics per user |
↳ userId | string | Gong's unique numeric identifier for the user |
↳ userEmailAddress | string | Email address of the Gong user |
↳ callsAsHost | number | Number of recorded calls this user hosted |
↳ callsAttended | number | Number of calls where this user was a participant (not host) |
↳ callsGaveFeedback | number | Number of recorded calls the user gave feedback on |
↳ callsReceivedFeedback | number | Number of recorded calls the user received feedback on |
↳ callsRequestedFeedback | number | Number of recorded calls the user requested feedback on |
↳ callsScorecardsFilled | number | Number of scorecards the user completed |
↳ callsScorecardsReceived | number | Number of calls where someone filled a scorecard on the user's calls |
↳ ownCallsListenedTo | number | Number of the user's own calls the user listened to |
↳ othersCallsListenedTo | number | Number of other users' calls the user listened to |
↳ callsSharedInternally | number | Number of calls the user shared internally |
↳ callsSharedExternally | number | Number of calls the user shared externally |
↳ callsCommentsGiven | number | Number of calls where the user provided at least one comment |
↳ callsCommentsReceived | number | Number of calls where the user received at least one comment |
↳ callsMarkedAsFeedbackGiven | number | Number of calls where the user selected Mark as reviewed |
↳ callsMarkedAsFeedbackReceived | number | Number of calls where others selected Mark as reviewed on the user's calls |
timeZone | string | The company's defined timezone in Gong |
fromDateTime | string | Start of results in ISO-8601 format |
toDateTime | string | End of results in ISO-8601 format |
cursor | string | Pagination cursor for the next page |
Retrieve detailed day-by-day activity (call IDs per activity type) for users by date range from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
userIds | string | Non | Comma-separated list of Gong user IDs (up to 20 digits each) |
fromDate | string | Oui | Start date in YYYY-MM-DD format (inclusive, in company timezone) |
toDate | string | Oui | End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
requestId | string | A Gong request reference ID for troubleshooting purposes |
usersDetailedActivities | array | Day-by-day activity per user, with call IDs grouped by activity type |
↳ userId | string | Gong's unique numeric identifier for the user |
↳ userEmailAddress | string | Email address of the Gong user |
↳ userDailyActivityStats | array | One record per day in the date range |
↳ fromDate | string | Start of the day (ISO-8601) |
↳ toDate | string | End of the day (ISO-8601) |
↳ callsAsHost | array | IDs of calls the user hosted |
↳ callsAttended | array | IDs of calls the user attended (not host) |
↳ callsGaveFeedback | array | IDs of calls the user gave feedback on |
↳ callsReceivedFeedback | array | IDs of calls the user received feedback on |
↳ callsRequestedFeedback | array | IDs of calls the user requested feedback on |
↳ callsScorecardsFilled | array | IDs of calls the user filled scorecards on |
↳ callsScorecardsReceived | array | IDs of the user's calls that received a scorecard |
↳ ownCallsListenedTo | array | IDs of the user's own calls the user listened to |
↳ othersCallsListenedTo | array | IDs of other users' calls the user listened to |
↳ callsSharedInternally | array | IDs of calls the user shared internally |
↳ callsSharedExternally | array | IDs of calls the user shared externally |
↳ callsCommentsGiven | array | IDs of calls the user commented on |
↳ callsCommentsReceived | array | IDs of the user's calls that received a comment |
↳ callsMarkedAsFeedbackGiven | array | IDs of calls the user marked as reviewed |
↳ callsMarkedAsFeedbackReceived | array | IDs of the user's calls marked as reviewed by others |
cursor | string | Pagination cursor for the next page |
Retrieve aggregated user activity grouped into time periods (day, week, month, quarter, year) by date range from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
aggregationPeriod | string | Oui | Calendar period to group activity by: DAY, WEEK, MONTH, QUARTER, or YEAR (week starts Monday) |
userIds | string | Non | Comma-separated list of Gong user IDs (up to 20 digits each) |
fromDate | string | Oui | Start date in YYYY-MM-DD format (inclusive, in company timezone) |
toDate | string | Oui | End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
requestId | string | A Gong request reference ID for troubleshooting purposes |
usersAggregateActivity | array | Aggregated activity per user, one item per consecutive time period in the range |
↳ userId | string | Gong's unique numeric identifier for the user |
↳ userEmailAddress | string | Email address of the Gong user |
↳ userAggregateActivity | array | Activity counts per time period |
↳ fromDate | string | Start of the period (ISO-8601) |
↳ toDate | string | End of the period (ISO-8601) |
↳ callsAsHost | number | Calls the user hosted |
↳ callsAttended | number | Calls the user attended (not host) |
↳ callsGaveFeedback | number | Calls the user gave feedback on |
↳ callsReceivedFeedback | number | Calls the user received feedback on |
↳ callsRequestedFeedback | number | Calls the user requested feedback on |
↳ callsScorecardsFilled | number | Scorecards the user completed |
↳ callsScorecardsReceived | number | Calls where someone filled a scorecard on the user's calls |
↳ ownCallsListenedTo | number | The user's own calls the user listened to |
↳ othersCallsListenedTo | number | Other users' calls the user listened to |
↳ callsSharedInternally | number | Calls the user shared internally |
↳ callsSharedExternally | number | Calls the user shared externally |
↳ callsCommentsGiven | number | Calls the user commented on |
↳ callsCommentsReceived | number | Calls where the user's calls received a comment |
↳ callsMarkedAsFeedbackGiven | number | Calls the user marked as reviewed |
↳ callsMarkedAsFeedbackReceived | number | The user's calls marked as reviewed by others |
cursor | string | Pagination cursor for the next page |
Retrieve interaction statistics for users by date range from Gong. Only includes calls with Whisper enabled.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
userIds | string | Non | Comma-separated list of Gong user IDs (up to 20 digits each) |
fromDate | string | Oui | Start date in YYYY-MM-DD format (inclusive, in company timezone) |
toDate | string | Oui | End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
peopleInteractionStats | array | Interaction statistics per user. Applicable stat names: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'. |
↳ userId | string | Gong's unique numeric identifier for the user |
↳ userEmailAddress | string | Email address of the Gong user |
↳ personInteractionStats | array | List of interaction stat measurements for this user |
↳ name | string | Stat name (e.g. Longest Monologue, Interactivity, Patience, Question Rate) |
↳ value | number | Stat measurement value (can be double or integer) |
timeZone | string | The company's defined timezone in Gong |
fromDateTime | string | Start of results in ISO-8601 format |
toDateTime | string | End of results in ISO-8601 format |
cursor | string | Pagination cursor for the next page |
Retrieve answered scorecards for reviewed users or by date range from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
callFromDate | string | Non | Start date for calls in YYYY-MM-DD format (inclusive, in company timezone). Defaults to earliest recorded call. |
callToDate | string | Non | End date for calls in YYYY-MM-DD format (exclusive, in company timezone). Defaults to latest recorded call. |
reviewFromDate | string | Non | Start date for reviews in YYYY-MM-DD format (inclusive, in company timezone). Defaults to earliest reviewed call. |
reviewToDate | string | Non | End date for reviews in YYYY-MM-DD format (exclusive, in company timezone). Defaults to latest reviewed call. |
scorecardIds | string | Non | Comma-separated list of scorecard IDs to filter by |
reviewedUserIds | string | Non | Comma-separated list of reviewed user IDs to filter by |
cursor | string | Non | Pagination cursor from a previous response |
| Paramètre | Type | Description |
|---|
answeredScorecards | array | List of answered scorecards with scores and answers |
↳ answeredScorecardId | number | Identifier of the answered scorecard |
↳ scorecardId | number | Identifier of the scorecard |
↳ scorecardName | string | Scorecard name |
↳ callId | number | Gong's unique numeric identifier for the call |
↳ callStartTime | string | Date/time of the call in ISO-8601 format |
↳ reviewedUserId | number | User ID of the team member being reviewed |
↳ reviewerUserId | number | User ID of the team member who completed the scorecard |
↳ reviewTime | string | Date/time when the review was completed in ISO-8601 format |
↳ visibilityType | string | Visibility type of the scorecard answer |
↳ answers | array | Answers in the answered scorecard |
↳ questionId | number | Identifier of the question |
↳ questionRevisionId | number | Identifier of the revision version of the question |
↳ isOverall | boolean | Whether this is the overall question |
↳ score | number | Score between 1 to 5 if answered, null otherwise |
↳ answerText | string | The answer's text if answered, null otherwise |
↳ notApplicable | boolean | Whether the question is not applicable to this call |
cursor | string | Pagination cursor for the next page |
Retrieve library folders from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
workspaceId | string | Non | Gong workspace ID to filter folders |
| Paramètre | Type | Description |
|---|
folders | array | List of library folders with id, name, and parent relationships |
↳ id | string | Gong unique numeric identifier for the folder |
↳ name | string | Display name of the folder |
↳ parentFolderId | string | Gong unique numeric identifier for the parent folder (null for root folder) |
↳ createdBy | string | Gong unique numeric identifier for the user who added the folder |
↳ updated | string | Folder's last update time in ISO-8601 format |
Retrieve the list of calls in a specific library folder from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
folderId | string | Oui | The library folder ID to retrieve content for |
| Paramètre | Type | Description |
|---|
folderId | string | Gong's unique numeric identifier for the folder |
folderName | string | Display name of the folder |
createdBy | string | Gong's unique numeric identifier for the user who added the folder |
updated | string | Folder's last update time in ISO-8601 format |
calls | array | List of calls in the library folder |
↳ id | string | Gong unique numeric identifier of the call |
↳ title | string | The title of the call |
↳ note | string | A note attached to the call in the folder |
↳ addedBy | string | Gong unique numeric identifier for the user who added the call |
↳ created | string | Date and time the call was added to folder in ISO-8601 format |
↳ url | string | URL of the call |
↳ snippet | object | Call snippet time range |
↳ fromSec | number | Snippet start in seconds relative to call start |
↳ toSec | number | Snippet end in seconds relative to call start |
Retrieve scorecard definitions from Gong settings.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
| Paramètre | Type | Description |
|---|
scorecards | array | List of scorecard definitions with questions |
↳ scorecardId | string | Unique identifier for the scorecard |
↳ scorecardName | string | Display name of the scorecard |
↳ workspaceId | string | Workspace identifier associated with this scorecard |
↳ enabled | boolean | Whether the scorecard is active |
↳ updaterUserId | string | ID of the user who last modified the scorecard |
↳ created | string | Creation timestamp in ISO-8601 format |
↳ updated | string | Last update timestamp in ISO-8601 format |
↳ questions | array | List of questions in the scorecard |
↳ questionId | string | Unique identifier for the question |
↳ questionText | string | The text content of the question |
↳ questionRevisionId | string | Identifier for the specific revision of the question |
↳ isOverall | boolean | Whether this is the primary overall question |
↳ created | string | Question creation timestamp in ISO-8601 format |
↳ updated | string | Question last update timestamp in ISO-8601 format |
↳ updaterUserId | string | ID of the user who last modified the question |
Retrieve smart tracker and keyword tracker definitions from Gong settings.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
workspaceId | string | Non | The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned. |
| Paramètre | Type | Description |
|---|
trackers | array | List of keyword tracker definitions |
↳ trackerId | string | Unique identifier for the tracker |
↳ trackerName | string | Display name of the tracker |
↳ workspaceId | string | ID of the workspace containing the tracker |
↳ languageKeywords | array | Keywords organized by language |
↳ language | string | ISO 639-2/B language code ("mul" means keywords apply across all languages) |
↳ keywords | array | Words and phrases in the designated language |
↳ includeRelatedForms | boolean | Whether to include different word forms |
↳ affiliation | string | Speaker affiliation filter: "Anyone", "Company", or "NonCompany" |
↳ partOfQuestion | boolean | Whether to track keywords only within questions |
↳ saidAt | string | Position in call: "Anytime", "First", or "Last" |
↳ saidAtInterval | number | Duration to search (in minutes or percentage) |
↳ saidAtUnit | string | Unit for saidAtInterval |
↳ saidInTopics | array | Topics where keywords should be detected |
↳ saidInCallParts | array | Specific call segments to monitor |
↳ filterQuery | string | JSON-formatted call filtering criteria |
↳ created | string | Creation timestamp in ISO-8601 format |
↳ creatorUserId | string | ID of the user who created the tracker (null for built-in trackers) |
↳ updated | string | Last modification timestamp in ISO-8601 format |
↳ updaterUserId | string | ID of the user who last modified the tracker |
List all company workspaces in Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
| Paramètre | Type | Description |
|---|
workspaces | array | List of Gong workspaces |
↳ id | string | Gong unique numeric identifier for the workspace |
↳ name | string | Display name of the workspace |
↳ description | string | Description of the workspace's purpose or content |
List Gong Engage flows (sales engagement sequences).
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
flowOwnerEmail | string | Oui | Email of a Gong user. The API will return 'PERSONAL' flows belonging to this user in addition to 'COMPANY' flows. |
workspaceId | string | Non | Optional workspace ID to filter flows to a specific workspace |
cursor | string | Non | Pagination cursor from a previous API call to retrieve the next page of records |
| Paramètre | Type | Description |
|---|
requestId | string | A Gong request reference ID for troubleshooting purposes |
flows | array | List of Gong Engage flows |
↳ id | string | The ID of the flow |
↳ name | string | The name of the flow |
↳ folderId | string | The ID of the folder this flow is under |
↳ folderName | string | The name of the folder this flow is under |
↳ visibility | string | The flow visibility type (COMPANY, PERSONAL, or SHARED) |
↳ creationDate | string | Creation time of the flow in ISO-8601 format |
↳ exclusive | boolean | Indicates whether a prospect in this flow can be added to other flows |
totalRecords | number | Total number of flow records available |
currentPageSize | number | Number of records returned in the current page |
currentPageNumber | number | Current page number |
cursor | string | Pagination cursor for retrieving the next page of records |
Retrieve coaching metrics for a manager from Gong.
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
managerId | string | Oui | Gong user ID of the manager |
workspaceId | string | Oui | Gong workspace ID |
fromDate | string | Oui | Start date in ISO-8601 format |
toDate | string | Oui | End date in ISO-8601 format |
| Paramètre | Type | Description |
|---|
requestId | string | A Gong request reference ID for troubleshooting purposes |
coachingData | array | A list of coaching data entries, one per manager's team |
↳ manager | object | The manager user information |
↳ id | string | Gong unique numeric identifier for the user |
↳ emailAddress | string | Email address of the Gong user |
↳ firstName | string | First name of the Gong user |
↳ lastName | string | Last name of the Gong user |
↳ title | string | Job title of the Gong user |
↳ directReportsMetrics | array | Coaching metrics for each direct report |
↳ report | object | The direct report user information |
↳ id | string | Gong unique numeric identifier for the user |
↳ emailAddress | string | Email address of the Gong user |
↳ firstName | string | First name of the Gong user |
↳ lastName | string | Last name of the Gong user |
↳ title | string | Job title of the Gong user |
↳ metrics | json | A map of metric names to arrays of string values representing coaching metrics |
Find all references to an email address in Gong (calls, email messages, meetings, CRM data, engagement).
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
emailAddress | string | Oui | Email address to look up |
| Paramètre | Type | Description |
|---|
requestId | string | Gong request reference ID for troubleshooting |
calls | array | Related calls referencing this email address |
↳ id | string | Gong's unique numeric identifier for the call (up to 20 digits) |
↳ status | string | Call status |
↳ externalSystems | array | Links to external systems such as CRM, Telephony System, etc. |
↳ system | string | External system name |
↳ objects | array | List of objects within the external system |
↳ objectType | string | Object type |
↳ externalId | string | External ID |
emails | array | Related email messages referencing this email address |
↳ id | string | Gong's unique 32 character identifier for the email message |
↳ from | string | The sender's email address |
↳ sentTime | string | Date and time the email was sent in ISO-8601 format |
↳ mailbox | string | The mailbox from which the email was retrieved |
↳ messageHash | string | Hash code of the email message |
meetings | array | Related meetings referencing this email address |
↳ id | string | Gong's unique identifier for the meeting |
customerData | array | Links to data from external systems (CRM, Telephony, etc.) that reference this email |
↳ system | string | External system name |
↳ objects | array | List of objects in the external system |
↳ id | string | Gong's unique numeric identifier for the Lead or Contact (up to 20 digits) |
↳ objectType | string | Object type |
↳ externalId | string | External ID |
↳ mirrorId | string | CRM Mirror ID |
↳ fields | array | Object fields |
↳ name | string | Field name |
↳ value | json | Field value |
customerEngagement | array | Customer engagement events (such as viewing external shared calls) |
↳ eventType | string | Event type |
↳ eventName | string | Event name |
↳ timestamp | string | Date and time the event occurred in ISO-8601 format |
↳ contentId | string | Event content ID |
↳ contentUrl | string | Event content URL |
↳ reportingSystem | string | Event reporting system |
↳ sourceEventId | string | Source event ID |
Find all references to a phone number in Gong (calls, email messages, meetings, CRM data, and associated contacts).
| Paramètre | Type | Obligatoire | Description |
|---|
accessKey | string | Oui | Gong API Access Key |
accessKeySecret | string | Oui | Gong API Access Key Secret |
phoneNumber | string | Oui | Phone number to look up (must start with + followed by country code) |
| Paramètre | Type | Description |
|---|
requestId | string | Gong request reference ID for troubleshooting |
suppliedPhoneNumber | string | The phone number that was supplied in the request |
matchingPhoneNumbers | array | Phone numbers found in the system that match the supplied number |
emailAddresses | array | Email addresses associated with the phone number |
calls | array | Related calls referencing this phone number |
↳ id | string | Gong's unique numeric identifier for the call (up to 20 digits) |
↳ status | string | Call status |
↳ externalSystems | array | Links to external systems such as CRM, Telephony System, etc. |
↳ system | string | External system name |
↳ objects | array | List of objects within the external system |
↳ objectType | string | Object type |
↳ externalId | string | External ID |
emails | array | Related email messages associated with contacts matching this phone number |
↳ id | string | Gong's unique 32 character identifier for the email message |
↳ from | string | The sender's email address |
↳ sentTime | string | Date and time the email was sent in ISO-8601 format |
↳ mailbox | string | The mailbox from which the email was retrieved |
↳ messageHash | string | Hash code of the email message |
meetings | array | Related meetings associated with this phone number |
↳ id | string | Gong's unique identifier for the meeting |
customerData | array | Links to data from external systems (CRM, Telephony, etc.) that reference this phone number |
↳ system | string | External system name |
↳ objects | array | List of objects in the external system |
↳ id | string | Gong's unique numeric identifier for the Lead or Contact (up to 20 digits) |
↳ objectType | string | Object type |
↳ externalId | string | External ID |
↳ mirrorId | string | CRM Mirror ID |
↳ fields | array | Object fields |
↳ name | string | Field name |
↳ value | json | Field value |
