Coveo Search Hubs API

The Search Hubs API from Coveo — 3 operation(s) for search hubs.

Operations 6

POST /rest/organizations/{organizationId}/searchusagemetrics/hubs/ Creates a Search Hub in the Organization #
GET /rest/organizations/{organizationId}/searchusagemetrics/hubs/ Lists the Search Hubs for an Organization #
DELETE /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName} Deletes a Search Hub for an Organization #
GET /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName} Gets a Specific Search Hub for an Organization #
PUT /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName} Updates a Search Hub in an Organization #
PUT /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName}/bucket Updates a Search Hub Bucket in an Organization, Creating the Hub If Required #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-passagev3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetrequest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresultvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupby-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-resthighlightresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restquerycorrection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparameters-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparentresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restrankingfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesrequestv3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesresponsev3-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-passagev3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetrequest-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresultvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupby-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-resthighlightresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restquerycorrection-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparameters-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparentresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restrankingfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesrequestv3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesresponsev3-structure.json

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/coveo-search-hubs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

coveo-search-hubs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Coveo Search Usage Metrics Service Search Hubs API
  version: 1.0.0
  description: Documentation for Coveo Search Usage Metrics Service
  termsOfService: http://www.coveo.com/en/support/terms-agreements
  contact:
    name: ''
    url: ''
    email: support@coveo.com
  license:
    name: ''
    url: ''
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- name: Search Hubs
paths:
  /rest/organizations/{organizationId}/searchusagemetrics/hubs/:
    post:
      operationId: createSearchHub
      summary: Creates a Search Hub in the Organization
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestSearchHub'
        description: The search hub data
        required: true
    get:
      operationId: listSearchHubs
      summary: Lists the Search Hubs for an Organization
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: minimumQueries
        description: The minimum number of queries required for a search hub to be listed
        required: false
        in: query
        schema:
          type: string
          default: '1'
      - name: filter
        description: The free-form string to filter the returned list based on the values of the search hub attributes.
        required: false
        in: query
        schema:
          type: string
      - name: pageSize
        description: The maximum number of organizations to list per page.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          default: '100'
      - name: page
        description: The 0-based index number of the page to list.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          default: '0'
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestSearchHub'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName}:
    delete:
      operationId: deleteSearchHub
      summary: Deletes a Search Hub for an Organization
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: hubName
        description: The search hub name
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
    get:
      operationId: getSearchHub
      summary: Gets a Specific Search Hub for an Organization
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: hubName
        description: The search hub name
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestSearchHub'
      security:
      - oauth2:
        - full
    put:
      operationId: updateSearchHub
      summary: Updates a Search Hub in an Organization
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: hubName
        description: The search hub name
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestSearchHub'
        description: The search hub data
        required: true
  /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName}/bucket:
    put:
      operationId: updateSearchHubBucket
      summary: Updates a Search Hub Bucket in an Organization, Creating the Hub If Required
      tags:
      - Search Hubs
      deprecated: false
      parameters:
      - name: bucket
        description: The search hub bucket
        required: true
        in: query
        schema:
          type: string
      - name: hubName
        description: The search hub name
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
components:
  schemas:
    RestSearchHub:
      type: object
      properties:
        name:
          example: '"myhub"'
          description: The name of the search hub
          type: string
        bucket:
          example: '"qpm"'
          description: The usage bucket to count queries from this hub into
          type: string
        description:
          example: '"Public search page"'
          description: A description for the search hub
          type: string
      required:
      - name
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            full: full
          authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
      description: OAuth2