Coveo Insight Panel API

openapi: 3.0.1
info:
  title: Coveo Activity Activities Insight Panel API
  description: API for Coveo Platform
  termsOfService: https://www.coveo.com/en/support/terms-agreements
  contact:
    name: Coveo
    url: https://connect.coveo.com/s/discussions
  version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
security:
- oauth2:
  - full
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
  /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
  /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
  /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
  /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
  /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
  /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
  /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
  /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'
    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'
  /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'
    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'
    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
  /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'
  /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'
  /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'
  /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'
components:
  schemas:
    RestInsightPanelSearchResponse:
      type: object
      properties:
        totalCount:
          type: integer
          description: <p>The total number of items that match the query for the current user (security trimming applied).</p> <p><strong>Note:</strong> When logging a Search Usage Analytics event for a query, the <code>numberOfResults</code> field of that event should be set to the <code>totalCount</code> value of the query (for reporting purposes).</p>
          example: 250
        totalCountFiltered:
          type: integer
          description: <p>The total number of items that match the query for the current user (security trimming applied) after duplicate filtering has been applied (see the <code>duplicateFiltering</code> query parameter).</p>
          example: 245
        duration:
          type: integer
          description: <p>The <code>requestDuration</code> added to the computing time (in milliseconds) that was required by the Search API.</p>
          example: 1235
        indexDuration:
          type: object
          description: <p>The time (in milliseconds) that was required for the index to find the query items.</p>
          example: '1175'
        requestDuration:
          type: integer
          description: <p>The <code>indexDuration</code> added to the time (in milliseconds) that was required to establish a connection between the Search API server and the index server.</p>
          example: 1181
        searchUid:
          type: string
          description: <p>The query <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a>. Each query sent to the Search API has its own randomly generated <code>searchUid</code>.</p> <p><strong>Note:</strong> When logging a Search or Custom Usage Analytics event for a query, or a Click Usage Analytics event for an opened query result item, the <code>searchQueryUid</code> field of that event should be set to the <code>searchUid</code> value of the query response.</p>
          example: a0e4773c-39c3-423c-90cd-c03a640ecde5
        pipeline:
          type: string
          description: <p>The name of the query pipeline to use for this request (bypassing its conditions, if it has any).</p>
          example: CustomQueryPipeline
        apiVersion:
          type: integer
          description: <p>The version of the Search API that sent the query.</p>
          example: 2
        exception:
          type: object
          properties:
            code:
              type: string
            context:
              type: string
        isFallbackToAdmin:
          type: boolean
          description: <p>Whether the admin session ID was allowed and used by the Coveo for Salesforce search engine. The value will be set to <code>true</code> when this is the case, and might be absent or set to <code>false</code> otherwise.</p>
        warnings:
          type: array
          description: <p>The errors that did not make the query fail, but should be addressed. These might be security issues, deprecated behaviors, or any other kind of concern.</p>
          items:
            type: string
        errors:
          type: array
          description: <p>The errors that critically changed the query behavior. These should be addressed right away to prevent future errors.</p>
          items:
            type: string
        index:
          type: string
          description: <p>The identifier of the index mirror against which the query was executed (see the <code>indexToken</code> query parameter).</p>
          example: mycoveocloudv2organizationid-cqjd206sta1xb9qyxfhhnsu294-Indexer-2-9rbfxhp1n07cth80ckzeh3zotc
        indexToken:
          type: string
          description: <p>The Base64 encoded identifier of the index mirror to which the request was forwarded (see the <code>index</code> parameter).</p> <p>If you do not specify an <code>indexToken</code> (or <code>index</code>) value, any index mirror could be used.</p> <p><strong>Note:</strong> Passing an <code>indexToken</code> (or <code>index</code>) value has no effect when the results of a specific request can be returned from cache (see the <code>maximumAge</code> query parameter).</p>
          example: ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==
        triggers:
          type: object
          properties:
            type:
              type: string
              description: <p>The type of Coveo query pipeline Trigger statement (see <a href="https://docs.coveo.com/en/3413">Manage trigger rules</a>).</p>
              example: notify
            content:
              type: object
              properties: {}
          description: <p>The actions that the client should perform based on the Trigger statements defined in the query pipelines (see the <code>pipeline</code> query parameter).</p> <p><strong>Note:</strong> A trigger statement must have a condition. Otherwise, the Search API ignores it and does not include it in the <code>triggers</code> array of the query response (see <a href="https://docs.coveo.com/en/3413">Manage trigger rules</a>).</p>
        termsToHighlight:
          type: object
          properties: {}
          description: <p>The terms to highlight in each query result item. Includes all basic query expression keywords, as well as any word that was stemmed from a basic query expression keyword (see the <code>q</code> query parameter), unless the keyword was preceded by the no stemming Coveo query syntax operator (<code>+</code>).</p>
          example:
            coveo: []
            cloud:
            - clouds
            v2: []
            platform:
            - platforms
        phrasesToHighlight:
          type: object
          properties: {}
          description: <p>The phrases to highlight in each query result item. This property is populated when the basic query expression (see the <code>q</code> query parameter) contains one or more exact phrase match requests (terms between double quote characters).</p>
          example:
            cloud v2:
              cloud: []
              v2: []
        queryCorrections:
          type: object
          properties:
            correctedQuery:
              type: string
              description: The corrected query expression.
              example: Coveo Cloud V2 platform
            wordCorrections:
              type: array
              description: The word correction suggestions.
              items:
                type: object
                properties:
                  offset:
                    type: integer
                    description: The offset (in number of characters) of the corrected word, from the beginning of the corrected query expression.
                    example: 15
                  length:
                    type: integer
                    description: The length (in number of characters) of the corrected word.
                    example: 8
                  originalWord:
                    type: string
                    description: The original, un-corrected word.
                    example: platfomr
                  correctedWord:
                    type: string
                    description: The suggested word correction.
                    example: platform
          description: <p>The query corrections suggested by the index, if the <code>enableDidYouMean</code> query parameter was set to <code>true</code>.</p>
        refinedKeywords:
          type: array
          description: The refined keywords used by the Co

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