Skip to end of metadata
Go to start of metadata

This topic describes the members of the structure holding information about a single Group By result. Group By results are returned in an array through the groupByResults member of the top-level response.

field: Field on which the Group By was performed

This is the name of the field that was used to perform the Group By.

values: Group By values generated by the Group By operation

This value holds an array of Group By values returned by the Group By operation (see Group By Values).

Group By Values

This section describes the members of the structure holding a single Group By value. One Group By value is generated for each distinct field value encountered in the result set by a Group By operation.

value: Value of the field in the results

This field holds the value of the field linked to the current Group By value. It corresponds to a field value of the field on which the Group By was performed in the result set matching the query expressions.

lookupValue: Value of the lookup field

This field holds the value of the requested lookup field for one random result having the field value linked to this Group By value. If no lookup value was requested, this value won't be included. 

numberOfResults: Number of occurrences of this value in the result set

This value specifies how many times the field value for this Group By value was encountered in the result set.

score: Computed score of the Group By value

This value is the computed score of the Group By value, calculated from the number of occurrences & the position of the corresponding items in the result set.

computedFieldResults: Computed field results for this Group By value

This field holds an array of computed field results returned by the Group By operation for this Group By value. Each entry in the array is a floating point value holding the result of the computed field operation. Results are returned in the same order in which they were requested.

valueType: Type of Group By value

This specifies the type of group by value for the current value. The possible values are:

ValueDescription
DesiredThe value was included because it was explicitly requested through the allowedValues field (see Group By Parameters).
StandardThe value was included simply because it is present in the query results (e.g. for no special reason).
  • No labels