Coveo Search V2 API

openapi: 3.0.1
info:
  title: Coveo Activity Activities Search V2 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: Search V2
  x-displayName: Search
paths:
  /rest/search/v2:
    get:
      tags:
      - Search V2
      summary: Send Search Request
      description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: searchUsingGet
      parameters:
      - $ref: '#/components/parameters/Q'
      - $ref: '#/components/parameters/AQ'
      - $ref: '#/components/parameters/CQ'
      - $ref: '#/components/parameters/DQ'
      - $ref: '#/components/parameters/LQ'
      - $ref: '#/components/parameters/EnableDidYouMean'
      - $ref: '#/components/parameters/MlDidYouMeanMaxCandidates'
      - $ref: '#/components/parameters/MlDidYouMeanMinScore'
      - $ref: '#/components/parameters/MlDidYouMeanUseFacetCount'
      - $ref: '#/components/parameters/EnableMlDidYouMean'
      - $ref: '#/components/parameters/PartialMatch'
      - $ref: '#/components/parameters/PartialMatchKeywords'
      - $ref: '#/components/parameters/PartialMatchThreshold'
      - $ref: '#/components/parameters/LqPartialMatchMaxKeywords'
      - $ref: '#/components/parameters/LqPartialMatchKeywords'
      - $ref: '#/components/parameters/LqPartialMatchThreshold'
      - $ref: '#/components/parameters/Wildcards'
      - $ref: '#/components/parameters/QuestionMark'
      - $ref: '#/components/parameters/EnableQuerySyntax'
      - $ref: '#/components/parameters/LowerCaseOperators'
      - $ref: '#/components/parameters/ExcerptLength'
      - $ref: '#/components/parameters/RetrieveFirstSentences'
      - $ref: '#/components/parameters/FieldsToInclude'
      - $ref: '#/components/parameters/FieldsToExclude'
      - $ref: '#/components/parameters/GroupBy'
      - $ref: '#/components/parameters/Facets'
      - $ref: '#/components/parameters/FacetOptions'
      - $ref: '#/components/parameters/CategoryFacets'
      - $ref: '#/components/parameters/SortCriteria'
      - $ref: '#/components/parameters/RankingFunctions'
      - $ref: '#/components/parameters/QueryFunctions'
      - $ref: '#/components/parameters/FirstResult'
      - $ref: '#/components/parameters/NumberOfResults'
      - $ref: '#/components/parameters/EnableDuplicateFiltering'
      - $ref: '#/components/parameters/FilterField'
      - $ref: '#/components/parameters/ParentField'
      - $ref: '#/components/parameters/ChildField'
      - $ref: '#/components/parameters/FilterFieldRange'
      - $ref: '#/components/parameters/SummaryLength'
      - $ref: '#/components/parameters/SortField'
      - $ref: '#/components/parameters/DisableQuerySyntax'
      - $ref: '#/components/parameters/StaticQuery'
      - $ref: '#/components/parameters/UserActionParameter'
      - $ref: '#/components/parameters/CommerceParameters'
      - $ref: '#/components/parameters/DictionaryFieldContext'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Search V2
      summary: Send Search Request
      description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: searchUsingPost
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestQueryParameters'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: '#/components/schemas/RestQueryResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/plan:
    get:
      tags:
      - Search V2
      summary: Plan Search Execution
      description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: planSearchUsingGet
      parameters:
      - $ref: '#/components/parameters/Q'
      - $ref: '#/components/parameters/AQ'
      - $ref: '#/components/parameters/CQ'
      - $ref: '#/components/parameters/DQ'
      - $ref: '#/components/parameters/LQ'
      - $ref: '#/components/parameters/EnableDidYouMean'
      - $ref: '#/components/parameters/MlDidYouMeanMaxCandidates'
      - $ref: '#/components/parameters/MlDidYouMeanMinScore'
      - $ref: '#/components/parameters/MlDidYouMeanUseFacetCount'
      - $ref: '#/components/parameters/EnableMlDidYouMean'
      - $ref: '#/components/parameters/PartialMatch'
      - $ref: '#/components/parameters/PartialMatchKeywords'
      - $ref: '#/components/parameters/PartialMatchThreshold'
      - $ref: '#/components/parameters/LqPartialMatchMaxKeywords'
      - $ref: '#/components/parameters/LqPartialMatchKeywords'
      - $ref: '#/components/parameters/LqPartialMatchThreshold'
      - $ref: '#/components/parameters/Wildcards'
      - $ref: '#/components/parameters/QuestionMark'
      - $ref: '#/components/parameters/EnableQuerySyntax'
      - $ref: '#/components/parameters/LowerCaseOperators'
      - $ref: '#/components/parameters/ExcerptLength'
      - $ref: '#/components/parameters/RetrieveFirstSentences'
      - $ref: '#/components/parameters/FieldsToInclude'
      - $ref: '#/components/parameters/FieldsToExclude'
      - $ref: '#/components/parameters/GroupBy'
      - $ref: '#/components/parameters/Facets'
      - $ref: '#/components/parameters/FacetOptions'
      - $ref: '#/components/parameters/CategoryFacets'
      - $ref: '#/components/parameters/SortCriteria'
      - $ref: '#/components/parameters/RankingFunctions'
      - $ref: '#/components/parameters/QueryFunctions'
      - $ref: '#/components/parameters/FirstResult'
      - $ref: '#/components/parameters/NumberOfResults'
      - $ref: '#/components/parameters/EnableDuplicateFiltering'
      - $ref: '#/components/parameters/FilterField'
      - $ref: '#/components/parameters/ParentField'
      - $ref: '#/components/parameters/ChildField'
      - $ref: '#/components/parameters/FilterFieldRange'
      - $ref: '#/components/parameters/SummaryLength'
      - $ref: '#/components/parameters/SortField'
      - $ref: '#/components/parameters/DisableQuerySyntax'
      - $ref: '#/components/parameters/StaticQuery'
      - $ref: '#/components/parameters/UserActionParameter'
      - $ref: '#/components/parameters/CommerceParameters'
      - $ref: '#/components/parameters/DictionaryFieldContext'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanSearchResponse'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Search V2
      summary: Plan Search Execution
      description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: planSearchUsingPost
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestQueryParameters'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanSearchResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/querySuggest:
    get:
      tags:
      - Search V2
      summary: Request Query Suggestions
      description: 'See [Getting Query Suggestions](https://docs.coveo.com/en/1459/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: querySuggestGet
      parameters:
      - name: q
        in: query
        description: 'The *basic query* expression, typically the keywords entered by the end user in a query box.

          '
        example: Coveo "Cloud V2" platform
        schema:
          type: string
      - name: autoCompleter
        in: query
        description: This parameter is exposed for backward compatibility reasons.
        schema:
          type: string
        deprecated: true
      - name: additionalData
        in: query
        deprecated: true
        description: This parameter is exposed for backward compatibility reasons.
        content:
          application/json:
            schema:
              type: object
      - name: count
        in: query
        description: 'The desired number of query suggestions.

          '
        schema:
          type: integer
          format: int32
      - name: enableWordCompletion
        in: query
        description: 'Whether to attempt to complete the last word of the current basic query expression (see the `q` parameter) and boost the ranking score of the resulting expression so that it is returned as the first query suggestion.

          '
        schema:
          type: boolean
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/OrganizationIdQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySuggestResponse'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Search V2
      summary: Request Query Suggestions
      description: 'See [Getting Query Suggestions](https://docs.coveo.com/en/1459/).

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: querySuggestPost
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestQuerySuggestParameters'
      responses:
        '200':
          description: The suggested completions for the query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySuggestResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/facet:
    post:
      tags:
      - Search V2
      summary: Send Facet Search Request
      description: 'Executes a facet search request.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: facetSearch
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestFacetSearchParameters'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestFacetSearchResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/fields:
    get:
      tags:
      - Search V2
      summary: List All Fields
      description: 'Gets all fields in the target Coveo Cloud organization.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: fields
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      responses:
        '200':
          description: The list of fields available for this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFieldsResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/values:
    get:
      tags:
      - Search V2
      summary: Get Values for One Field
      description: 'Lists all values of the target field.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: valuesGet
      parameters:
      - name: field
        in: query
        description: 'The name of the field from which to retrieve values.

          '
        required: true
        schema:
          type: string
      - name: lookupField
        in: query
        description: 'This parameter is exposed for backward compatibility reasons.


          The name of an additional field from which to retrieve values.'
        schema:
          type: string
        deprecated: true
      - name: ignoreAccents
        in: query
        description: 'Whether to treat accentuated characters as non-accentuated characters when retrieving field values (e.g., treat `é`, `è`, `ê`, etc., as `e`).


          **Default:** `true`

          '
        schema:
          type: boolean
      - name: sortCriteria
        in: query
        description: 'The sort criteria to use.


          Use:

          - `occurrences` to sort by number of occurrences, with field values having the highest number of occurrences appearing first.

          - `nosort` to avoid sorting the results of the Group By operation. The field values will appear in an unspecified order.


          **Default:** `occurrences`

          '
        schema:
          type: string
      - name: maximumNumberOfValues
        in: query
        description: 'The maximum number of field values to return.


          **Default:** `10`

          '
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: queryOverride
        in: query
        description: 'A different basic query expression (q) use.

          '
        schema:
          type: string
      - name: constantQueryOverride
        in: query
        description: 'A different constant query expression (cq) to use.

          '
        schema:
          type: string
      - name: disjunctionQueryOverride
        in: query
        description: 'A different disjunction query expression (dq) to use.

          '
        schema:
          type: string
      - name: pattern
        in: query
        description: 'The pattern that the field values must match.


          See also the `patternType` parameter."

          '
        schema:
          type: string
      - name: patternType
        in: query
        description: 'The type of pattern that is being used to list field values.


          Use:

          - `wildcard` to parse the specified `pattern` as a wildcard expression.

          - `regularexpression` to parse the specified `pattern` as a regular expression.

          - `editdistance` to apply the Edit Distance algorithm to match values that are close to the specified `pattern`.

          - `phonetic` to apply a phonetic algorithm to match values that are phonetically similar to the specified `pattern`.


          **Default:** `wildcard`

          '
        schema:
          type: string
      - $ref: '#/components/parameters/CommerceParameters'
      - $ref: '#/components/parameters/DictionaryFieldContext'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFieldValuesResponse'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Search V2
      summary: Get Values for One Field
      description: 'Lists all values of the target field.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: valuesPost
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestListFieldValuesParameter'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFieldValuesResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/values/batch:
    get:
      tags:
      - Search V2
      summary: Get Values for Several Field
      description: 'Lists all values of the target field.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: valuesBatchGet
      parameters:
      - name: batch
        in: query
        description: 'An array of parameters to retrieve field values.

          '
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RestListFieldValuesBatchParameter'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFieldValuesBatchResponse'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Search V2
      summary: Get Values for Several Field
      description: 'Lists all values of the target field.

        <details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
      operationId: valuesBatchPost
      parameters:
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestListFieldValuesBatchParameter'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFieldValuesBatchResponse'
      security:
      - oauth2:
        - full
  /rest/search/v2/html:
    get:
      tags:
      - Search V2
      summary: Get HTML Item Preview
      operationId: htmlGet
      parameters:
      - name: uniqueId
        in: query
        description: 'The uniqueId of the document. Exactly one of uniqueId or primaryId is required.


          **Deprecated:** Use `primaryId` instead.'
        schema:
          type: string
      - name: primaryId
        in: query
        description: The primaryId of the document. Exactly one of uniqueId or primaryId is required.
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationIdQuery'
      - name: findNext
        in: query
        schema:
          type: integer
          format: int32
      - name: findPrevious
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: enableNavigation
        in: query
        schema:
          type: boolean
      - name: requestedOutputSize
        in: query
        description: The approximate number of bytes to request in the HTML response. **Default:** `0`, meaning that the entire HTML document is requested.
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/Q'
      - $ref: '#/components/parameters/AQ'
      - $ref: '#/components/parameters/CQ'
      - $ref: '#/components/parameters/DQ'
      - $ref: '#/components/parameters/LQ'
      - $ref: '#/components/parameters/EnableDidYouMean'
      - $ref: '#/components/parameters/MlDidYouMeanMaxCandidates'
      - $ref: '#/components/parameters/MlDidYouMeanMinScore'
      - $ref: '#/components/parameters/MlDidYouMeanUseFacetCount'
      - $ref: '#/components/parameters/EnableMlDidYouMean'
      - $ref: '#/components/parameters/PartialMatch'
      - $ref: '#/components/parameters/PartialMatchKeywords'
      - $ref: '#/components/parameters/PartialMatchThreshold'
      - $ref: '#/components/parameters/LqPartialMatchMaxKeywords'
      - $ref: '#/components/parameters/LqPartialMatchKeywords'
      - $ref: '#/components/parameters/LqPartialMatchThreshold'
      - $ref: '#/components/parameters/Wildcards'
      - $ref: '#/components/parameters/QuestionMark'
      - $ref: '#/components/parameters/EnableQuerySyntax'
      - $ref: '#/components/parameters/LowerCaseOperators'
      - $ref: '#/components/parameters/ExcerptLength'
      - $ref: '#/components/parameters/RetrieveFirstSentences'
      - $ref: '#/components/parameters/FieldsToInclude'
      - $ref: '#/components/parameters/FieldsToExclude'
      - $ref: '#/components/parameters/GroupBy'
      - $ref: '#/components/parameters/Facets'
      - $ref: '#/components/parameters/FacetOptions'
      - $ref: '#/components/parameters/CategoryFacets'
      - $ref: '#/components/parameters/SortCriteria'
      - $ref: '#/components/parameters/RankingFunctions'
      - $ref: '#/components/parameters/QueryFunctions'
      - $ref: '#/components/parameters/FirstResult'
      - $ref: '#/components/parameters/NumberOfResults'
      - $ref: '#/components/parameters/EnableDuplicateFiltering'
      - $ref: '#/components/parameters/FilterField'
      - $ref: '#/components/parameters/ParentField'
      - $ref: '#/components/parameters/ChildField'
      - $ref: '#/components/parameters/FilterFieldRange'
      - $ref: '#/components/parameters/SummaryLength'
      - $ref: '#/components/parameters/SortField'
      - $ref: '#/components/parameters/DisableQuerySyntax'
      - $ref: '#/components/parameters/StaticQuery'
      - $ref: '#/components/parameters/UserActionParameter'
      - $ref: '#/components/parameters/CommerceParameters'
      - $ref: '#/components/parameters/DictionaryFieldContext'
      - $ref: '#/components/parameters/Pipeline'
      - $ref: '#/components/parameters/MaximumAge'
      - $ref: '#/components/parameters/SearchHub'
      - $ref: '#/components/parameters/Tab'
      - $ref: '#/components/parameters/Referrer'
      - $ref: '#/components/parameters/Context'
      - $ref: '#/components/parameters/ActionsHistory'
      - $ref: '#/components/parameters/Recommendation'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Debug'
      - $ref: '#/components/parameters/IndexToken'
      - $ref: '#/components/parameters/VisitorId'
      - $ref: '#/components/parameters/IsGuestUser'
      - $ref: '#/components/parameters/Language'
      - $ref: '#/components/parameters/MlParameters'
      - $ref: '#/components/parameters/IndexType'
      - $ref: '#/components/parameters/Index'
      - $ref: '#/components/parameters/LogicalIndex'
      - $ref: '#/components/parameters/MaximumTimeoutMs'
      - $ref: '#/components/parameters/AnalyticsRequestParameters'
      - $ref: '#/components/parameters/ViewAllContentQuery'
      responses:
        '200':
          description: No response
          content: {}
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - oauth2:
        - full
      description: '<details>

        <summary>Privilege(s) required</summary>


        ```json

        {"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}

        ```

        </details>'
  

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