Coveo · JSON Structure

Coveo Search Restgroupbyresult Structure

Type: Properties: 0
AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

RestGroupByResult is a JSON Structure definition published by Coveo.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "RestGroupByResult",
  "structure": {
    "type": "object",
    "required": [
      "field",
      "globalComputedFieldResults",
      "values"
    ],
    "properties": {
      "field": {
        "type": "string",
        "description": "The field on which the Group By operation was executed."
      },
      "values": {
        "type": "array",
        "description": "The resulting Group By values.",
        "items": {
          "type": "object",
          "required": [
            "computedFieldResults",
            "lookupValue",
            "numberOfResults",
            "score",
            "value",
            "valueType"
          ],
          "properties": {
            "value": {
              "type": "string",
              "description": "The Group By value name."
            },
            "numberOfResults": {
              "type": "integer",
              "format": "int32",
              "description": "The number of query result items having this field value."
            },
            "score": {
              "type": "integer",
              "format": "int32",
              "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."
            },
            "valueType": {
              "type": "string",
              "description": "The type of Group By value."
            },
            "computedFieldResults": {
              "type": "array",
              "description": "The results of the computed fields (see the `computedFields` Group By parameter).",
              "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."
            },
            "Value": {
              "type": "string",
              "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
            },
            "NumberOfResults": {
              "type": "integer",
              "format": "int32",
              "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
            },
            "Score": {
              "type": "integer",
              "format": "int32",
              "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
            },
            "ComputedFieldResults": {
              "type": "array",
              "description": "> This property is deprecated; it should not be populated by Search API V2 searches.",
              "items": {
                "type": "number",
                "format": "double"
              }
            },
            "LookupValue": {
              "type": "string",
              "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
            }
          }
        }
      },
      "globalComputedFieldResults": {
        "type": "array",
        "description": "The global computed fields that were processed by the index.",
        "items": {
          "type": "number",
          "format": "double"
        }
      },
      "Field": {
        "type": "string",
        "description": "> This property is deprecated and Coveo Cloud V1 only; The lowercase `field` should be used instead."
      },
      "GlobalComputedFieldResults": {
        "type": "array",
        "description": "> This property is deprecated and V1 only; The lowercase `globalComputedFieldResults` should be used instead.",
        "items": {
          "type": "number",
          "format": "double"
        }
      }
    }
  }
}