Aggregates an incoming data set by the desired level for all numeric properties specified in the payload.
Version 1
HTTP RequestPOST /ado/v1/Aggregate
Header
| Parameter | Description |
|---|---|
| Ocp-Apim-Subscription-Key | The subscription key you received when you purchased a plan. |
Request Body
Mandatory
| Parameter | Type | Description |
|---|---|---|
| aggregationType | String | The aggregation operation to perform. Must be one of the following values … Sum, Count, Avg, Max or Min |
| aggregateBy | String[] | The properties to include in the resulting aggregation. Supports the dynamic property selection syntax. Dynamic Property Selections |
| aggregateOn | String[] | The numeric fields to aggregate on. The operation parameter indicates the type of aggregation performed.Supports the dynamic property selection syntax. |
| data | Object[] | Array containing one or more single level objects. |
Common
Further Documentation: Common Parameters
| Parameter | Type | Description |
|---|---|---|
| filter | String | A fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included. |
| sortOrder | Object | Sorts the resulting dataset by the criteria provided. The object should contain property names that represent properties contained within the resulting dataset with a value corresponding to the desired sort direction (i.e. ASC or DESC). |
| schema | Object | You can use this parameter to override the inferred schema for properties in the incoming dataset(s). A field will be inferred unless specific explicitly within this object. |
| advancedOptions | Object | Is an object with the following properties. cultureName (String) The specified culture determines the behaviour for aspects related to formatting numeric values and dates. Is extremely important when converting strings to dates, e.g. 05/03/2022 will be treated differently between locales. For more information on the accepted values for this property, please consult the documentation from Microsoft … https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-6.0#culture-names-and-identifiers isBoolean (string[]) A list of strings that are the names of all properties in the resulting dataset that should be treated as boolean values. By default, the framework treats boolean values as 1 (true) or 0 (false). In order to differentiate the integer as a boolean, the property in question needs to be called out explicitly in this list. |
Examples
Sum
Avg