Coveo Insight Panel API

openapi: 3.2.0
info:
  title: Coveo Insight Panel API
  version: 1.0.0
  contact:
    name: support@coveo.com
  description: 'Operations tagged Insight Panel across 2 of this provider''s published API definitions: coveo-customer-service-openapi-original.yml, coveo-search-interface-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- name: Insight Panel
  x-displayName: Insight Panel
paths:
  /rest/organizations/{organizationId}/insightconfig/v1/configs:
    get:
      tags:
      - Insight Panel
      summary: List Insight Panel Configurations
      description: Gets a list of Insight Panel configurations.
      operationId: insight-panel-configuration-list
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The 0-based number of the page of configurations to list.
        schema:
          type: integer
          format: Int32
          default: 0
      - name: perPage
        in: query
        description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
        schema:
          type: integer
          format: Int32
          default: 10
      - name: filter
        in: query
        description: A filter that only retrieves matching Insight Panel configurations.
        schema:
          type: string
      - name: order
        in: query
        description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: List of Insight Panel configurations
                    items:
                      $ref: '#/components/schemas/RestInsightPanelConfiguration'
                  totalEntries:
                    type: integer
                    description: The total number of items that match the <code>filter</code> parameter.
                  totalPages:
                    type: integer
                    description: The total number of item pages according to the <code>perPage</code> parameter.
      deprecated: false
      security:
      - oauth2:
        - full
    post:
      tags:
      - Insight Panel
      summary: Create an Insight Panel Configuration
      description: Creates a new Insight Panel configuration.
      operationId: insight-panel-configuration-create
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RestInsightPanelConfigurationCreate'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestInsightPanelConfiguration'
      deprecated: false
      security:
      - oauth2:
        - full
      x-codegen-request-body-name: body
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightconfig/v1/configs/ids:
    post:
      tags:
      - Insight Panel
      summary: List Insight Panel Configurations by Ids.
      description: Gets a list of Insight Panel configurations by ids.
      operationId: insight-panel-configuration-list-ids
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The 0-based number of the page of configurations to list.
        schema:
          type: integer
          format: Int32
          default: 0
      - name: perPage
        in: query
        description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
        schema:
          type: integer
          format: Int32
          default: 10
      - name: filter
        in: query
        description: A filter that only retrieves matching Insight Panel configurations.
        schema:
          type: string
      - name: order
        in: query
        description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>'
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RestInsightPanelConfigurationListIds'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: List of Insight Panel configurations
                    items:
                      $ref: '#/components/schemas/RestInsightPanelConfiguration'
                  totalEntries:
                    type: integer
                    description: The total number of items that match the <code>filter</code> parameter.
                  totalPages:
                    type: integer
                    description: The total number of item pages according to the <code>perPage</code> parameter.
      deprecated: false
      security:
      - oauth2:
        - full
      x-codegen-request-body-name: body
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}:
    get:
      tags:
      - Insight Panel
      summary: Get an Insight Panel Configuration
      description: Gets a single Insight Panel configuration.
      operationId: insight-panel-configuration-get
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the target Insight Panel configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestInsightPanelConfiguration'
        '404':
          description: When the specified Insight Panel configuration does not exist.
          content: {}
      deprecated: false
      security:
      - oauth2:
        - full
    put:
      tags:
      - Insight Panel
      summary: Update an Insight Panel Configuration
      description: Updates an existing Insight Panel configuration.
      operationId: insight-panel-configuration-update
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the target Insight Panel configuration.
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RestInsightPanelConfigurationUpdate'
        required: false
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestInsightPanelConfiguration'
        '404':
          description: When the specified Insight Panel configuration does not exist.
          content: {}
      deprecated: false
      security:
      - oauth2:
        - full
      x-codegen-request-body-name: body
    delete:
      tags:
      - Insight Panel
      summary: Delete an Insight Panel Configuration
      description: Deletes an existing Insight Panel configuration.
      operationId: insight-panel-configuration-delete
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the target Insight Panel configuration.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
        '404':
          description: When the specified Insight Panel configuration does not exist.
          content: {}
      deprecated: false
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insight/v1/configs/{configId}/interface:
    get:
      tags:
      - Insight Panel
      summary: Get an Insight Panel Interface
      description: Gets a specific Insight Panel interface.
      operationId: insight-panel-interface-get
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the target Insight Panel configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: object
                properties:
                  contextFields:
                    type: object
                    properties: {}
                    example:
                      subject: case_subject
                      description: case_description
                  searchHub:
                    type: string
                  interface:
                    $ref: '#/components/schemas/RestInsightPanelInterface'
      deprecated: false
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insight/v1/configs/{configId}/search:
    post:
      tags:
      - Insight Panel
      summary: Search for Items
      description: Searches for items using a specific Insight Panel configuration.
      operationId: insight-panel-search
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the Insight Panel configuration.
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RestInsightPanelSearchRequest'
        required: false
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestInsightPanelSearchResponse'
      deprecated: false
      security:
      - oauth2:
        - full
      x-codegen-request-body-name: body
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insight/v1/configs/{configId}/querysuggest:
    post:
      tags:
      - Insight Panel
      summary: Retrieve Query Suggestions
      description: Retrieves query suggestions using a specific Insight Panel configuration.
      operationId: insight-panel-query-suggest
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the Insight Panel configuration.
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RestInsightPanelQuerySuggestRequest'
        required: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestInsightPanelQuerySuggestResponse'
      deprecated: false
      security:
      - oauth2:
        - full
      x-codegen-request-body-name: body
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insight/v1/configs/{configId}/quickview:
    get:
      tags:
      - Insight Panel
      summary: Retrieve Item Quickview
      description: Retrieves an item Quickview using a specific Insight Panel configuration.
      operationId: insight-panel-quickview
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: configId
        in: path
        description: The unique identifier of the target Insight Panel configuration.
        required: true
        schema:
          type: string
      - name: uniqueId
        in: query
        description: The unique identifier of the target document.
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: <p>The basic query expression, typically the keywords entered by the end user in a query box.</p> <p><strong>Note:</strong> When logging a <strong>Search</strong> Usage Analytics event for a query, the <code>queryText</code> field of that event should be set to the <code>q</code> value of the corresponding query.</p>
        schema:
          type: string
      - name: enableNavigation
        in: query
        description: Provide controls to the end user for navigating through the matching keywords in the document.
        schema:
          type: boolean
      - name: requestedOutputSize
        in: query
        description: The approximate number of bytes to request in the HTML response. <strong>Default:</strong> <code>0</code>, meaning that the entire HTML document is requested.
        schema:
          type: integer
      responses:
        '200':
          description: The item's HTML preview.
          content: {}
      deprecated: false
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightconfig/v1/configs/projects/get:
    get:
      tags:
      - Insight Panel
      summary: Get Insight Configurations by Project
      description: Retrieves insight panel configurations associated with a specific project in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br /><b>Required privilege:</b> Customer Service - Insight panel configuration - View
      operationId: getInsightConfigurationsByProject
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: projectId
        in: query
        description: The unique identifier of the project for which to retrieve insight panel configurations.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The 0-based number of the page of configurations to list.<br /><b>Default:</b> `0`
        schema:
          type: integer
          format: int32
      - name: perPage
        in: query
        description: The maximum number of configurations to include per page.<br /><b>Default:</b> `100`
        schema:
          type: integer
          format: int32
      - name: filter
        in: query
        description: A filter that only retrieves matching Insight Panel configurations.
        schema:
          type: string
      - name: order
        in: query
        description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestListOfInsightPanelConfigurationsWithProjects'
      deprecated: false
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces:
    post:
      operationId: create-insight-panel-interface
      summary: Create an Insight Panel Interface
      description: Create an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightPanelBodyParams'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
      security:
      - oauth2:
        - full
    get:
      operationId: get-all-insight-panel-interfaces
      summary: Get All Insight Panel Interfaces
      description: Get all [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interfaces in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InsightPanelInterface'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}:
    get:
      operationId: get-insight-panel-interface
      summary: Get an Insight Panel Interface
      description: Get an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
      security:
      - oauth2:
        - full
    put:
      operationId: update-insight-panel-interface
      summary: Update an Insight Panel Interface
      description: Update an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightPanelBodyParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
      security:
      - oauth2:
        - full
    delete:
      operationId: delete-insight-panel-interface
      summary: Delete an Insight Panel Interface
      description: Delete an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      responses:
        '204':
          description: NoContent
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions:
    get:
      operationId: get-insight-panel-interface-versions
      summary: Get Versions for an Insight Panel Interface
      description: Get a list of versions of the [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface of a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/versions-page'
      - $ref: '#/components/parameters/versions-per-page'
      - $ref: '#/components/parameters/versions-filter'
      - $ref: '#/components/parameters/versions-order'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfoPage'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}:
    get:
      operationId: get-insight-panel-interface-version
      summary: Get an Insight Panel Interface Version
      description: Get information about a specific version of an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#components/schemas/InsightInterfaceVersionInfo'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore:
    post:
      operationId: restore-insight-panel-interface-version
      summary: Restore an Insight Panel Interface Version
      description: Restore the current [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface to a specific version.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label:
    put:
      operationId: update-insight-panel-interface-version-label
      summary: Update an Insight Panel Interface Version Label
      description: Update the label for a specific [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface version.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfo'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
components:
  schemas:
    RestContentId:
      type: object
      properties:
        contentIdKey:
          type: string
        contentIdValue:
          type: string
    RestInsightPanelInterface:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the Insight Panel interface.
        name:
          type: string
          description: The name of the Insight Panel interface. It is usually the same as the name of the Insight Panel configuration.
        resultTemplates:
          type: array
          description: The result templates configured for the Insight Panel interface.
          items:
            type: object
            properties:
              name:
                type: string
                description: The name of the result template.
              layout:
                type: string
                description: The layout of the result template. The allowed values are <code>default</code> and <code>thumbnail</code>.
                default: default
              conditions:
                $ref: '#/components/schemas/RestConditions'
              badge:
                type: object
                properties:
                  field:
                    type: string
                    description: The name of the field from which the value is retrieved.
                  label:
                    type: string
                    description: A specific label to display.
                  color:
                    type: string
                    description: The hexadecimal color code.
                    example: '#5080F0'
              details:
                type: array
                items:
                  type: object
                  properties:
                    field:
                      type: string
                    label:
                      type: string
              resultActions:
                type: object
                properties:
                  attachToCase:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                    description: Users can attach items to the current CRM object (e.g., an opened case).
                  copyToClipboard:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                    description: Users can copy a result to their clipboard.
                  quickView:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                    description: Users can preview a result without leaving the search page.
                  sendAsEmail:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                    description: Users can insert a link to an item into an email.
                  sendToFeed:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                    description: Users can insert a link to an item into a post.
                description: Indicates the actions that are available on each result.
        facets:
          type: array
          description: The facets configured for the Insight Panel interface.
          items:
            type: object
            properties:
              field:
                type: string
                description: The name of the facet field.
              label:
                type: string
                description: The title of the facet.
              displayValuesAs:
                type: string
                description: Whether to display the facet values as checkboxes (multiple selection), links (single selection), or boxes (multiple selection). Possible values are <code>checkbox</code>, <code>link</code>, and <code>box</code>.
                example: link
                default: checkbox
        tabs:
          type: array
          description: The tabs configured for the Insight Panel interface.
          items:
            type: object
            properties:
              label:
                type: string
                description: The caption for the tab.
                example: People
              conditions:
                $ref: '#/components/schemas/RestConditions'
        settings:
          type: object
          properties:
            createArticle:
              type: object
              properties:
                enabled:
                  type: boolean
            fullSearch:
              type: object
              properties:
                enabled:
                  type: boolean
          description: The settings for the Insight Panel interface.
    RestInsightPanelConfigurationCreate:
      required:
      - name
      - pipeline
      type: object
      properties:
        name:
          type: string
          description: The name of the Insight Panel configuration.
          example: My Insight Panel
        pipeline:
          type: string
          description: The ID of the query pipeline to use.
        contextFields:
          type: object
          properties: {}
          description: A dictionary in which the keys represent context keys, and the values are CRM field names.
          example:
            subject: case_subject
            description: case_description
        interfaces:
          type: array
          description: A list of i

# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-insight-panel-api-openapi.yml