Aggregate Parameters Overview (Spider)

[Table of Contents](https://github.com/dell-oss/Doradus/wiki/Spider Databases: Table-of-Contents) | Previous | Next
Spider Aggregate Queries: Aggregate Parameters Overview

---

Aggregate queries use the following parameters:

• Metric (required): Defines one or more functions to calculate for selected objects. Metric functions such as COUNT, SUM, and MAX are supported. Each function is computed across selected objects, optionally subdivided into groups as defined by the grouping parameter. See the section Metric Parameter for details.

• Query (optional): A DQL query expression that selects objects in the perspective table. When this parameter is omitted, all objects in the table are included in metric computations.

• Grouping (optional): A list of one or more grouping expressions, which divide computations into single- or multi-level groups. When this parameter is omitted, the corresponding global query computes a single value for each metric function. When provided, the corresponding grouped query computes a value for each group value/metric function combination. A wide range of grouping expressions are supported as described in the section Grouping Parameter.

How parameters are passed depends on the REST command. Spider supports two commands for submitting aggregate queries:

• URI command: All parameters are passed in the URI of the command.

• Entity command: All parameters are passed in an entity (XML or JSON document) submitted with the command.

Details of each command are described in the section Spider REST Commands In the examples used in this section, the URI command is used. The following sections describe the more complex parameters used by aggregate queries.