Gong Coaching API

openapi: 3.2.0
info:
  title: Gong Coaching API
  description: 'Overview


    The Gong API allows you to:


    Receive the following information from Gong:


    Your company''s calls in Gong


    Your company''s users in Gong


    Your company''s user stats in Gong


    Your company''s user settings in Gong


    Your company''s libraries in Gong


    Upload new or

    update

    call recordings in Gong, in order to support cases where you have an internal system that records

    calls or obtains them from a third-party entity.


    Data Privacy:

    Delete users and all their associated elements.


    Upload CRM data into Gong.


    Check here what''s your base URL for all API calls.


    Authentication


    There are two ways to retrieve credentials to the Gong Public API:


    Retrieve Manually:


    In the Gong API Page (you

    must be a technical administrator in Gong), click "Create" to receive an Access Key

    and an Access Key Secret.


    Use the Basic Authorization HTTP header (as per RFC)

    to access the Public API as shown below:


    Authorization: Basic <token>


    To create the basic token, combine the Access Key and the Access Key Secret with

    colon (:) and then encode in Base64 as following:


    Base64(<accessKey> : <accessKeySecret>)


    Retrieve through OAuth


    To obtain the Bearer token, follow the steps described in the Gong OAuth Guide.


    After obtaining the token, use the Bearer Authorization HTTP header

    (as per RFC)

    to access the Public API as shown below:


    Authorization: Bearer <token>


    Limits


    By default Gong limits your company''s access to the service to 3 API calls per second, and 10,000 API calls per day.


    When the rate of API calls exceeds these limits an HTTP status code 429 is returned and a Retry-After header indicates

    how many seconds to wait before making a new request.


    If required, contact help.gong.io to change these limits.


    Cursors


    Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be

    required to bring all records. Such an API call also returns a records field, which contains the number of records

    in the current page, the current page number and the total number of records.


    In cases where the total number of records exceeds the number of records thus far retrieved, the records field will also

    contain a cursor field which can be used to access the next page of records. To retrieve the next page, repeat the API call with

    the cursor value as supplied by the previous API call. All other request inputs should remain the same.


    Forward Compatibility


    When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output.

    It is recommended to future proof your code so that it disregards all JSON fields you don''t actually use.'
  version: V2
servers:
- url: https://127.0.0.1:8443
  description: Generated server url
tags:
- name: Coaching
paths:
  /v2/coaching:
    get:
      tags:
      - Coaching
      summary: List all coaching metrics (/v2/coaching)
      description: 'List all of the coaching metrics of a manager.


        When accessed through a Bearer token authorization method, this endpoint requires the scope ''api:coaching:read''.'
      operationId: listUsers_1
      parameters:
      - name: workspace-id
        in: query
        required: true
        style: FORM
        explode: true
        schema:
          type: integer
          format: int64
          exampleSetFlag: false
          types:
          - integer
      - name: manager-id
        in: query
        required: true
        style: FORM
        explode: true
        schema:
          type: integer
          format: int64
          exampleSetFlag: false
          types:
          - integer
      - name: from
        in: query
        description: Association time filter - only the associations made after that time will be listed. The time is 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 all association events will be listed.
        required: true
        style: FORM
        explode: true
        schema:
          type: string
          exampleSetFlag: false
          types:
          - string
      - name: to
        in: query
        description: Association time filter - only the associations made after that time will be listed. The time is 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 all association events will be listed.
        required: true
        style: FORM
        explode: true
        schema:
          type: string
          exampleSetFlag: false
          types:
          - string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoachingMetrics'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: Malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
components:
  schemas:
    CoachingMetricsData:
      type: object
      properties:
        manager:
          $ref: '#/components/schemas/CoachingUser'
          exampleSetFlag: false
        directReportsMetrics:
          type: array
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/CoachingRepData'
            exampleSetFlag: false
          types:
          - array
      description: A list, in which each item specifies one managers coaching data
      exampleSetFlag: false
      types:
      - object
    CoachingUser:
      type: object
      properties:
        id:
          type: string
          description: Gong's unique numeric identifier for the user (up to 20 digits).
          example: '234599484848423'
          exampleSetFlag: true
          types:
          - string
        emailAddress:
          type: string
          description: The email address of the Gong user.
          example: test@test.com
          exampleSetFlag: true
          types:
          - string
        firstName:
          type: string
          description: The first name of the Gong user.
          example: Jon
          exampleSetFlag: true
          types:
          - string
        lastName:
          type: string
          description: The last name of the Gong user.
          example: Snow
          exampleSetFlag: true
          types:
          - string
        title:
          type: string
          description: The job title of the Gong user.
          example: Enterprise Account Executive
          exampleSetFlag: true
          types:
          - string
      exampleSetFlag: false
      types:
      - object
    CoachingRepData:
      type: object
      properties:
        report:
          $ref: '#/components/schemas/CoachingUser'
          exampleSetFlag: false
        metrics:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            exampleSetFlag: false
            items:
              type: string
              exampleSetFlag: false
              types:
              - string
            types:
            - array
          exampleSetFlag: false
          types:
          - object
      exampleSetFlag: false
      types:
      - object
    ErrorResponse:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        errors:
          type: array
          description: Error messages.
          example:
          - An error has occurred
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
            types:
            - string
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    CoachingMetrics:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        coachingData:
          type: array
          description: A list, in which each item specifies one managers coaching data
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/CoachingMetricsData'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
x-provenance:
  method: harvested
  publisher: Gong
  source: https://app.gong.io/ajax/settings/api/documentation/specs?version=
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)