Coveo · Schema

Coveo Search RestGroupByValue

AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

Properties

Name	Type	Description
value	string	The Group By value name.
numberOfResults	integer	The number of query result items having this field value.
score	integer	The Group By value score, computed from the `numberOfResults` value as well as from the position of the items having this value in the ranked query result set.
valueType	string	The type of Group By value.
computedFieldResults	array	The results of the computed fields (see the `computedFields` Group By parameter).
lookupValue	string	> This property is deprecated; it should normally not be populated if the query was sent against a Coveo Cloud V2 index. The lookup field value name.
Value	string	> This property is deprecated; it should not be populated by Search API V2 searches.
NumberOfResults	integer	> This property is deprecated; it should not be populated by Search API V2 searches.
Score	integer	> This property is deprecated; it should not be populated by Search API V2 searches.
ComputedFieldResults	array	> This property is deprecated; it should not be populated by Search API V2 searches.
LookupValue	string	> This property is deprecated; it should not be populated by Search API V2 searches.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-restgroupbyvalue-schema.json",
  "title": "Coveo Search RestGroupByValue",
  "required": [
    "computedFieldResults",
    "lookupValue",
    "numberOfResults",
    "score",
    "value",
    "valueType"
  ],
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The Group By value name.",
      "example": "Bob Jones"
    },
    "numberOfResults": {
      "type": "integer",
      "description": "The number of query result items having this field value.",
      "format": "int32",
      "example": 42
    },
    "score": {
      "type": "integer",
      "description": "The Group By value score, computed from the `numberOfResults` value as well as from the position of the items having this value in the ranked query result set.",
      "format": "int32",
      "example": 0
    },
    "valueType": {
      "type": "string",
      "description": "The type of Group By value.",
      "example": "Standard"
    },
    "computedFieldResults": {
      "type": "array",
      "description": "The results of the computed fields (see the `computedFields` Group By parameter).",
      "example": [
        243.72
      ],
      "items": {
        "type": "number",
        "format": "float"
      }
    },
    "lookupValue": {
      "type": "string",
      "description": "> This property is deprecated; it should normally not be populated if the query was sent against a Coveo Cloud V2 index.\n\nThe lookup field value name.",
      "deprecated": true
    },
    "Value": {
      "type": "string",
      "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
      "deprecated": true
    },
    "NumberOfResults": {
      "type": "integer",
      "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
      "format": "int32",
      "deprecated": true
    },
    "Score": {
      "type": "integer",
      "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
      "format": "int32",
      "deprecated": true
    },
    "ComputedFieldResults": {
      "type": "array",
      "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
      "deprecated": true,
      "items": {
        "type": "number",
        "format": "double"
      }
    },
    "LookupValue": {
      "type": "string",
      "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
      "deprecated": true
    }
  }
}