/
eventsAggregateApi.ts
40 lines (37 loc) · 1.18 KB
/
eventsAggregateApi.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// Copyright 2020 Cognite AS
import { BaseResourceAPI } from '@cognite/sdk-core';
import {
AggregateResponse,
EventAggregateQuery,
EventUniqueValuesAggregate,
UniqueValuesAggregateResponse,
} from '../../types';
export class EventsAggregateAPI extends BaseResourceAPI<unknown> {
/**
* [Aggregate events](https://docs.cognite.com/api/v1/#operation/aggregateEvents)
*
* ```js
* const aggregates = await client.events.aggregate.count({ filter: { assetIds: [1, 2, 3] } });
* console.log('Number of events: ', aggregates[0].count)
* ```
*/
public count = (query: EventAggregateQuery): Promise<AggregateResponse[]> => {
return super.aggregateEndpoint(query);
};
/**
* [Aggregate events](https://docs.cognite.com/api/v1/#operation/aggregateEvents)
*
* ```js
* const uniqueValues = await client.events.aggregate.uniqueValues({ filter: { assetIds: [1, 2, 3] }, fields: ['subtype'] });
* console.log('Unique values: ', uniqueValues)
* ```
*/
public uniqueValues = (
query: EventUniqueValuesAggregate
): Promise<UniqueValuesAggregateResponse[]> => {
return super.aggregateEndpoint({
...query,
aggregate: 'uniqueValues',
});
};
}