Coveo · JSON Structure

Coveo Search Restfacetresultvalue Structure

Type: Properties: 0
AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

RestFacetResultValue is a JSON Structure definition published by Coveo.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "RestFacetResultValue",
  "structure": {
    "type": "object",
    "required": [
      "numberOfResults",
      "state"
    ],
    "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."
      },
      "state": {
        "type": "string",
        "description": "The current facet value state in the search interface.\n\n**Default:** `idle`"
      },
      "numberOfResults": {
        "type": "integer",
        "format": "int64",
        "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."
      },
      "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`"
      },
      "isSuggested": {
        "type": "boolean"
      },
      "isAutoSelected": {
        "type": "boolean",
        "description": "Whether the facet value was automatically selected by Coveo ML."
      }
    }
  }
}