Class UserSearchAndAggregationBaseRequest
Represents an aggregation request over users.
Inheritance
UserSearchAndAggregationBaseRequest
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public abstract class UserSearchAndAggregationBaseRequest : UsersSearchBaseRequest
Properties
Special filters used to filter down independently the aggregations' values and the search results on specific conditions.
For the search results, the aggregation filters are used to create a Filter that is put in AND with the eventual existing Filter of the search request to nail down the search results. The filters generated
by the aggregation filters are put in OR each other if they have the same AggregationName, and then such groups are put in AND.
For the aggregation values, only the original Filter of the search request is used to nail down the data to be considered for the aggregations. Then, on top of that, for each aggregator in the search request, a Filter is created to filter down the
aggregation results of that aggregation: depending if the AggregationName of the AggregationFilter matches the AggregationName of the Aggregator, the filter is put in OR (if it matches) or in AND (if it does not match it).
Moreover, an AggregationFilter ensures that the related value is returned in the AggregationResults also if the top aggregation values returned by default do not contain it.
Declaration
[JsonProperty("aggregationFilters", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregationFilter> AggregationFilters { get; set; }
Property Value
Methods
Declaration
public static UserSearchAndAggregationBaseRequest FromJson(string data)
Parameters
Returns