const aggregates = await client.events.aggregate.count({ filter: { assetIds: [1, 2, 3] } });
console.log('Number of events: ', aggregates[0].count)
const uniqueValues = await client.events.aggregate.uniqueValues({ filter: { assetIds: [1, 2, 3] }, fields: ['subtype'] });
console.log('Unique values: ', uniqueValues){
"items": [
{
"count": 10
}
]
}Aggregate events
Required capabilities:
eventsAcl:READ
The aggregation API lets you compute aggregated results on events, such as getting the count of all Events in a project, checking different descriptions of events in your project, etc.
Aggregate filtering
Filter (filter & advancedFilter) data for aggregates
Filters behave the same way as for the Filter events endpoint.
In text properties, the values are aggregated in a case-insensitive manner.
aggregateFilter to filter aggregate results
aggregateFilter works similarly to advancedFilter but always applies to aggregate properties.
For instance, in an aggregation for the source property, only the values (aka buckets) of the source property can be filtered out.
Request throttling
This endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.
The Aggregates endpoint, as with all endpoints in the Events API, is subject to a request budget that applies
limits to both request rate and concurrency.
Please check Events resource description for more information.
const aggregates = await client.events.aggregate.count({ filter: { assetIds: [1, 2, 3] } });
console.log('Number of events: ', aggregates[0].count)
const uniqueValues = await client.events.aggregate.uniqueValues({ filter: { assetIds: [1, 2, 3] }, fields: ['subtype'] });
console.log('Unique values: ', uniqueValues){
"items": [
{
"count": 10
}
]
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
- EventCount
- EventWithPropertyCount
- ApproximateCardinalityForValues
- ApproximateCardinalityForProperties
- WithProperties
- WithFields
- UniqueProperties
Request aggregate to count the number of Events matching the filters. Default aggregate for the endpoint.
Type of aggregation to apply.
count: Get an approximate number of Events matching the filters.
count A query that matches items matching boolean combinations of other queries.
It's built using one or more boolean clauses of the following types: and, or, or not
- and
- or
- not
- equals
- in
- range
- prefix
- exists
- containsAny
- containsAll
- search
Show child attributes
Show child attributes
{
"or": [
{
"not": {
"and": [
{
"equals": {
"property": ["metadata", "severity"],
"value": "medium"
}
},
{
"in": {
"property": ["source"],
"values": ["inspection protocol", "incident report"]
}
},
{
"range": {
"property": ["dataSetId"],
"gte": 1,
"lt": 10
}
}
]
}
},
{
"and": [
{
"equals": {
"property": ["type"],
"value": "equipment malfunction"
}
},
{
"equals": {
"property": ["subtype"],
"value": "mechanical failure"
}
}
]
},
{
"search": {
"property": ["description"],
"value": "outage"
}
}
]
}
Filter on events filter with exact match
Show child attributes
Show child attributes
Response
Response with a list of aggregation results.
- CountResult
- BucketsResult
Common aggregate structure to represent aggregate result which have one count for filter resultset (Documents Count, Property Cardinality, etc).
1 elementShow child attributes
Show child attributes
Was this page helpful?