# GroupBy


# Description

The <GroupBy> tag allows you to group multiple indexes into one GroupBy index.

Each GroupBy index must be defined within the <GroupBys> tags.

Group Bys are used in combination with the tuple function in order to gather groups of data. It is primarily used with the GroupBy Request

# Syntax

<GroupBys>
    <GroupBy Name="string" Func="string" />
</GroupBys>

# Attributes

Note: attributes marked with * are required.

  • Name* (string) :
    • The name of your GroupBy index. This value must be unique among all other GroupBys.
  • Func* (string) :
    • The name of the aggregate function used to group multiple indexes.
  • Key (string) Replaces Func:
    • You may choose to use key to specify a JSON path in place of a function if the data you are providing is suitable. e.g. if you have both Latitude and Longitude under the key GeoLocations.Locations.