Coveo · Schema

Coveo Search RestFacetResultValue

Artificial IntelligenceAnalyticsCatalogCommerceCustomersExperienceMachine-LearningPersonalizationRecommendationsSearch

Properties

Name Type Description
value string The facet value name. **Note:** In the case of a hierarchical facet value, this represents a single path segment.
state string The current facet value state in the search interface. **Default:** `idle`
numberOfResults integer The number of query results that can be expected if the facet value is selected in the search interface. **Note:** This property only gets populated when the facet currently has no selected or exclude
start object The start of the range.
end object The end of the range.
endInclusive boolean Whether to include the `end` value in the range. **Default:** `false`
isSuggested boolean
isAutoSelected boolean Whether the facet value was automatically selected by Coveo ML.
View JSON Schema on GitHub

JSON Schema

coveo-search-restfacetresultvalue-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-restfacetresultvalue-schema.json",
  "title": "Coveo Search RestFacetResultValue",
  "required": [
    "numberOfResults",
    "state"
  ],
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "value": {
      "type": "string",
      "description": "The facet value name.\n\n**Note:** In the case of a hierarchical facet value, this represents a single path segment.",
      "example": "Alice Smith"
    },
    "state": {
      "type": "string",
      "description": "The current facet value state in the search interface.\n\n**Default:** `idle`",
      "enum": [
        "idle",
        "selected",
        "excluded"
      ]
    },
    "numberOfResults": {
      "type": "integer",
      "description": "The number of query results that can be expected if the facet value is selected in the search interface.\n\n**Note:** This property only gets populated when the facet currently has no selected or excluded values.",
      "format": "int64"
    },
    "start": {
      "description": "The start of the range.",
      "anyOf": [
        {
          "type": "string",
          "example": "2001-07-20T23:01:05"
        },
        {
          "type": "integer",
          "format": "int64"
        },
        {
          "type": "number"
        }
      ]
    },
    "end": {
      "description": "The end of the range.",
      "anyOf": [
        {
          "type": "string",
          "example": "2001-07-20T23:01:05"
        },
        {
          "type": "integer",
          "format": "int64"
        },
        {
          "type": "number"
        }
      ]
    },
    "endInclusive": {
      "type": "boolean",
      "description": "Whether to include the `end` value in the range.\n\n**Default:** `false`",
      "example": true,
      "default": false
    },
    "isSuggested": {
      "type": "boolean"
    },
    "isAutoSelected": {
      "type": "boolean",
      "description": "Whether the facet value was automatically selected by Coveo ML."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/coveo-search-restfacetresultvalue"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.