Aggregate records data from a stream
Aggregates records in a stream. Requires streamRecordsAcl:READ and dataModelsAcl:READ. See Aggregates.
POST
/
streams
/
{streamId}
/
records
/
aggregate
Python SDK
# Example: simple average
from cognite.client.data_classes.data_modeling.aggregates import Average
temperature = ["my-space", "my-container", "temperature"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={"avg_temperature": Average(temperature)},
)
# Example: count with last_updated_time filter
from cognite.client.data_classes.data_modeling.aggregates import Count
from cognite.client.data_classes.data_modeling.records import TimeRange
temperature = ["my-space", "my-container", "temperature"]
# 1759276800000 = 2025-10-01T00:00:00Z
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"total_readings": Count(),
"readings_with_temperature": Count(temperature),
},
last_updated_time=TimeRange(gt=1759276800000),
)
# Example: nested timeHistogram + uniqueValues
from cognite.client.data_classes.data_modeling.aggregates import Average, Max, Sum, TimeHistogram, UniqueValues
recorded_at = ["my-space", "my-container", "recorded_at"]
equipment_id = ["my-space", "my-container", "equipment_id"]
temperature = ["my-space", "my-container", "temperature"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"my_groups_by_1d_range": TimeHistogram(
property=recorded_at,
calendar_interval="1d",
aggregates={
"my_groups_by_equipment_id": UniqueValues(
property=equipment_id,
aggregates={
"my_equipment_daily_temperature_sum": Sum(temperature),
"my_equipment_daily_temperature_maximum": Max(temperature),
},
),
"my_daily_temperature_average": Average(temperature),
},
),
"my_temperature_maximum_across_all_readings": Max(temperature),
},
)
# Example: movingFunction over daily counts
from cognite.client.data_classes.data_modeling.aggregates import Count, MovingFunction, MovingFunctions, TimeHistogram
recorded_at = ["my-space", "my-container", "recorded_at"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"readings_per_day": TimeHistogram(
property=recorded_at,
calendar_interval="1d",
aggregates={
"readings": Count(),
"readings_7d_avg": MovingFunction(
buckets_path="readings",
window=7,
function=MovingFunctions.UNWEIGHTED_AVG,
),
},
),
},
)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aggregates": {
"my_groups_by_1d_range": {
"timeHistogram": {
"calendarInterval": "1d",
"property": [
"my-space",
"my-container",
"recorded_at"
],
"aggregates": {
"my_groups_by_equipment_id": {
"uniqueValues": {
"property": [
"my-space",
"my-container",
"equipment_id"
],
"aggregates": {
"my_equipment_daily_temperature_sum": {
"sum": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
},
"my_equipment_daily_temperature_maximum": {
"max": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
}
}
},
"my_daily_temperature_average": {
"avg": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
}
}
},
"my_temperature_maximum_across_all_readings": {
"max": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
},
"lastUpdatedTime": {
"gt": 1705341600000,
"lt": "2030-05-15T18:00:00.00Z"
},
"filter": {
"and": [
{
"containsAll": {
"property": [
"mySpace",
"myContainer",
"myProperty"
],
"values": [
"1001_1",
"1001_2"
]
}
},
{
"range": {
"property": [
"my_space",
"my_container",
"my_weight"
],
"gte": 0
}
},
{
"equals": {
"property": [
"my_space",
"my_view/v1",
"my_severity"
],
"value": "CRITICAL"
}
}
]
},
"targetUnits": {
"unitSystemName": "<string>"
},
"includeTyping": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aggregates: {
my_groups_by_1d_range: {
timeHistogram: {
calendarInterval: '1d',
property: ['my-space', 'my-container', 'recorded_at'],
aggregates: {
my_groups_by_equipment_id: {
uniqueValues: {
property: ['my-space', 'my-container', 'equipment_id'],
aggregates: {
my_equipment_daily_temperature_sum: {sum: {property: ['my-space', 'my-container', 'temperature']}},
my_equipment_daily_temperature_maximum: {max: {property: ['my-space', 'my-container', 'temperature']}}
}
}
},
my_daily_temperature_average: {avg: {property: ['my-space', 'my-container', 'temperature']}}
}
}
},
my_temperature_maximum_across_all_readings: {max: {property: ['my-space', 'my-container', 'temperature']}}
},
lastUpdatedTime: {gt: 1705341600000, lt: '2030-05-15T18:00:00.00Z'},
filter: {
and: [
{
containsAll: {
property: ['mySpace', 'myContainer', 'myProperty'],
values: ['1001_1', '1001_2']
}
},
{range: {property: ['my_space', 'my_container', 'my_weight'], gte: 0}},
{
equals: {property: ['my_space', 'my_view/v1', 'my_severity'], value: 'CRITICAL'}
}
]
},
targetUnits: {unitSystemName: '<string>'},
includeTyping: true
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aggregates' => [
'my_groups_by_1d_range' => [
'timeHistogram' => [
'calendarInterval' => '1d',
'property' => [
'my-space',
'my-container',
'recorded_at'
],
'aggregates' => [
'my_groups_by_equipment_id' => [
'uniqueValues' => [
'property' => [
'my-space',
'my-container',
'equipment_id'
],
'aggregates' => [
'my_equipment_daily_temperature_sum' => [
'sum' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
],
'my_equipment_daily_temperature_maximum' => [
'max' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
]
]
],
'my_daily_temperature_average' => [
'avg' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
]
]
],
'my_temperature_maximum_across_all_readings' => [
'max' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
],
'lastUpdatedTime' => [
'gt' => 1705341600000,
'lt' => '2030-05-15T18:00:00.00Z'
],
'filter' => [
'and' => [
[
'containsAll' => [
'property' => [
'mySpace',
'myContainer',
'myProperty'
],
'values' => [
'1001_1',
'1001_2'
]
]
],
[
'range' => [
'property' => [
'my_space',
'my_container',
'my_weight'
],
'gte' => 0
]
],
[
'equals' => [
'property' => [
'my_space',
'my_view/v1',
'my_severity'
],
'value' => 'CRITICAL'
]
]
]
],
'targetUnits' => [
'unitSystemName' => '<string>'
],
'includeTyping' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate"
payload := strings.NewReader("{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}"
response = http.request(request)
puts response.read_body{
"aggregates": {
"my_avg_aggregate1": {
"avg": 42
},
"my_terms_aggregate2": {
"uniqueValueBuckets": [
{
"value": "Cognite",
"count": 42,
"aggregates": {
"my_sub_aggregate1": {
"min": 13
},
"my_sub_aggregate2": {
"max": 69
},
"my_sub_aggregate3": {
"uniqueValueBuckets": [
{
"value": "us1",
"count": 42
},
{
"value": "ie1",
"count": 7
}
]
}
}
},
{
"value": "AkerBP",
"count": 21,
"aggregates": {
"my_sub_aggregate1": {
"min": 99
},
"my_sub_aggregate2": {
"max": 999
},
"my_sub_aggregate3": {
"uniqueValueBuckets": [
{
"value": "us1",
"count": 11
}
]
}
}
}
]
}
},
"typing": {}
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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.
Scopes
Path Parameters
An identifier of the stream where the records are stored.
Required string length:
1 - 100Pattern:
^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$Example:
"test1"
Body
application/json
Aggregation specification.
Defines an aggregation request. This will let you aggregate supported data types. The request supports filters, and allows optional search matching.
A dictionary of requested aggregates with client defined names/identifiers.
Example:
{
"my_aggr_1": {
"min": {"property": ["space1", "container1", "property1"]}
},
"my_aggr_2": {
"uniqueValues": {
"property": ["space1", "container2", "property1"],
"aggregates": {
"my_sub_aggr": {
"avg": {"property": ["space2", "container1", "property3"]}
}
}
}
},
}
Max number of (sub-)aggregate trees on a level is 5, Max aggregate tree depth is 5. Max number of aggregates in the forest is 16.
Note: All aggregate property references in the request combined can reference at most
one property source when a view is involved: either a single view and nothing else,
or any number of containers. Mixing a view with containers, or with another view, is rejected.
Show child attributes
Show child attributes
Example:
{
"my_groups_by_1d_range": {
"timeHistogram": {
"calendarInterval": "1d",
"property": ["my-space", "my-container", "recorded_at"],
"aggregates": {
"my_groups_by_equipment_id": {
"uniqueValues": {
"property": ["my-space", "my-container", "equipment_id"],
"aggregates": {
"my_equipment_daily_temperature_sum": {
"sum": {
"property": ["my-space", "my-container", "temperature"]
}
},
"my_equipment_daily_temperature_maximum": {
"max": {
"property": ["my-space", "my-container", "temperature"]
}
}
}
}
},
"my_daily_temperature_average": {
"avg": {
"property": ["my-space", "my-container", "temperature"]
}
}
}
}
},
"my_temperature_maximum_across_all_readings": {
"max": {
"property": ["my-space", "my-container", "temperature"]
}
}
}
Matches records with the last updated time within the provided range. This attribute is mandatory for immutable streams but it's optional for mutable streams. The maximum time interval that can be defined by the attribute is limited by the stream settings. If more data needs to be queried than allowed by the stream settings, it should be done with multiple requests. For example, if stream allows querying up to 1 month of data, but a quarterly report is needed, the solution is to make 3 requests, one for each month, and then aggregate the responses.
The range must include at least a left (gt or gte) bound.
It is not allowed to specify two upper or lower bounds, e.g. gte and gt, in the same filter.
gte: Greater than or equal to.
gt: Greater than.
lte: Less than or equal to.
lt: Less than.
Note: lastUpdatedTime is a CDF generated timestamp that marks the moment a record is stored in the API
The range bounds can be specified in two formats:
- String: An ISO-8601 formatted date-time string (e.g.,
2030-05-15T18:00:00.00Z). - Integer: The number of milliseconds since the Unix epoch (e.g.,
1705341600000).
Show child attributes
Show child attributes
Example:
{
"gt": 1705341600000,
"lt": "2030-05-15T18:00:00.00Z"
}
Build a new query by combining other queries, using boolean operators. We support the and, or, and
not boolean operators.
- and
- or
- not
- matchAll
- exists
- equals
- hasData
- prefix
- range
- in
- containsAll
- containsAny
Show child attributes
Show child attributes
Example:
{
"and": [
{
"containsAll": {
"property": ["mySpace", "myContainer", "myProperty"],
"values": ["1001_1", "1001_2"]
}
},
{
"range": {
"property": ["my_space", "my_container", "my_weight"],
"gte": 0
}
},
{
"equals": {
"property": ["my_space", "my_view/v1", "my_severity"],
"value": "CRITICAL"
}
}
]
}
Properties to convert to another unit. The API can only convert to another unit, if a unit has been defined as part of the type on the underlying container being queried.
Use unitSystemName to convert all properties to the target unit system without
specifying each property individually.
NB! Unit conversion is applied to both the response and the request. For example, let's assume
there is a temperature property with its unit defined as temperature:deg_c. If
one requests conversion of this property to temperature:k unit,
then all values of this property in response will be converted to Kelvin.
But also all values of this property in request (e.g. in a filter)
are expected to be provided in Kelvin.
- unitSystemName
- properties
Show child attributes
Show child attributes
If set to true, property type information will be included into response.
Only following properties are included:
- mentioned in
itemsresponse parameter (for/filterand/syncresponses) - mentioned in
filterrequest parameter - mentioned in
targetUnitsrequest parameter - mentioned in
aggregatesrequest parameter (for/aggregaterequest )
Example:
true
Response
Aggregated query results.
A dictionary of the results for the requested aggregates mapped by the aggregates identifiers.
Example:
{
"my_aggr_1": {
"avg": 42
},
"my_aggr_2": {
"max": 69
},
}
Show child attributes
Show child attributes
Example:
{
"my_avg_aggregate1": { "avg": 42 },
"my_terms_aggregate2": {
"uniqueValueBuckets": [
{
"value": "Cognite",
"count": 42,
"aggregates": {
"my_sub_aggregate1": { "min": 13 },
"my_sub_aggregate2": { "max": 69 },
"my_sub_aggregate3": {
"uniqueValueBuckets": [
{ "value": "us1", "count": 42 },
{ "value": "ie1", "count": 7 }
]
}
}
},
{
"value": "AkerBP",
"count": 21,
"aggregates": {
"my_sub_aggregate1": { "min": 99 },
"my_sub_aggregate2": { "max": 999 },
"my_sub_aggregate3": {
"uniqueValueBuckets": [{ "value": "us1", "count": 11 }]
}
}
}
]
}
}
Property type information. This attribute is present only if
includeTyping was set to true in request.
Show child attributes
Show child attributes
⌘I
Python SDK
# Example: simple average
from cognite.client.data_classes.data_modeling.aggregates import Average
temperature = ["my-space", "my-container", "temperature"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={"avg_temperature": Average(temperature)},
)
# Example: count with last_updated_time filter
from cognite.client.data_classes.data_modeling.aggregates import Count
from cognite.client.data_classes.data_modeling.records import TimeRange
temperature = ["my-space", "my-container", "temperature"]
# 1759276800000 = 2025-10-01T00:00:00Z
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"total_readings": Count(),
"readings_with_temperature": Count(temperature),
},
last_updated_time=TimeRange(gt=1759276800000),
)
# Example: nested timeHistogram + uniqueValues
from cognite.client.data_classes.data_modeling.aggregates import Average, Max, Sum, TimeHistogram, UniqueValues
recorded_at = ["my-space", "my-container", "recorded_at"]
equipment_id = ["my-space", "my-container", "equipment_id"]
temperature = ["my-space", "my-container", "temperature"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"my_groups_by_1d_range": TimeHistogram(
property=recorded_at,
calendar_interval="1d",
aggregates={
"my_groups_by_equipment_id": UniqueValues(
property=equipment_id,
aggregates={
"my_equipment_daily_temperature_sum": Sum(temperature),
"my_equipment_daily_temperature_maximum": Max(temperature),
},
),
"my_daily_temperature_average": Average(temperature),
},
),
"my_temperature_maximum_across_all_readings": Max(temperature),
},
)
# Example: movingFunction over daily counts
from cognite.client.data_classes.data_modeling.aggregates import Count, MovingFunction, MovingFunctions, TimeHistogram
recorded_at = ["my-space", "my-container", "recorded_at"]
res = client.data_modeling.records.aggregate(
stream_id="my-stream",
aggregates={
"readings_per_day": TimeHistogram(
property=recorded_at,
calendar_interval="1d",
aggregates={
"readings": Count(),
"readings_7d_avg": MovingFunction(
buckets_path="readings",
window=7,
function=MovingFunctions.UNWEIGHTED_AVG,
),
},
),
},
)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aggregates": {
"my_groups_by_1d_range": {
"timeHistogram": {
"calendarInterval": "1d",
"property": [
"my-space",
"my-container",
"recorded_at"
],
"aggregates": {
"my_groups_by_equipment_id": {
"uniqueValues": {
"property": [
"my-space",
"my-container",
"equipment_id"
],
"aggregates": {
"my_equipment_daily_temperature_sum": {
"sum": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
},
"my_equipment_daily_temperature_maximum": {
"max": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
}
}
},
"my_daily_temperature_average": {
"avg": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
}
}
},
"my_temperature_maximum_across_all_readings": {
"max": {
"property": [
"my-space",
"my-container",
"temperature"
]
}
}
},
"lastUpdatedTime": {
"gt": 1705341600000,
"lt": "2030-05-15T18:00:00.00Z"
},
"filter": {
"and": [
{
"containsAll": {
"property": [
"mySpace",
"myContainer",
"myProperty"
],
"values": [
"1001_1",
"1001_2"
]
}
},
{
"range": {
"property": [
"my_space",
"my_container",
"my_weight"
],
"gte": 0
}
},
{
"equals": {
"property": [
"my_space",
"my_view/v1",
"my_severity"
],
"value": "CRITICAL"
}
}
]
},
"targetUnits": {
"unitSystemName": "<string>"
},
"includeTyping": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aggregates: {
my_groups_by_1d_range: {
timeHistogram: {
calendarInterval: '1d',
property: ['my-space', 'my-container', 'recorded_at'],
aggregates: {
my_groups_by_equipment_id: {
uniqueValues: {
property: ['my-space', 'my-container', 'equipment_id'],
aggregates: {
my_equipment_daily_temperature_sum: {sum: {property: ['my-space', 'my-container', 'temperature']}},
my_equipment_daily_temperature_maximum: {max: {property: ['my-space', 'my-container', 'temperature']}}
}
}
},
my_daily_temperature_average: {avg: {property: ['my-space', 'my-container', 'temperature']}}
}
}
},
my_temperature_maximum_across_all_readings: {max: {property: ['my-space', 'my-container', 'temperature']}}
},
lastUpdatedTime: {gt: 1705341600000, lt: '2030-05-15T18:00:00.00Z'},
filter: {
and: [
{
containsAll: {
property: ['mySpace', 'myContainer', 'myProperty'],
values: ['1001_1', '1001_2']
}
},
{range: {property: ['my_space', 'my_container', 'my_weight'], gte: 0}},
{
equals: {property: ['my_space', 'my_view/v1', 'my_severity'], value: 'CRITICAL'}
}
]
},
targetUnits: {unitSystemName: '<string>'},
includeTyping: true
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aggregates' => [
'my_groups_by_1d_range' => [
'timeHistogram' => [
'calendarInterval' => '1d',
'property' => [
'my-space',
'my-container',
'recorded_at'
],
'aggregates' => [
'my_groups_by_equipment_id' => [
'uniqueValues' => [
'property' => [
'my-space',
'my-container',
'equipment_id'
],
'aggregates' => [
'my_equipment_daily_temperature_sum' => [
'sum' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
],
'my_equipment_daily_temperature_maximum' => [
'max' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
]
]
],
'my_daily_temperature_average' => [
'avg' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
]
]
],
'my_temperature_maximum_across_all_readings' => [
'max' => [
'property' => [
'my-space',
'my-container',
'temperature'
]
]
]
],
'lastUpdatedTime' => [
'gt' => 1705341600000,
'lt' => '2030-05-15T18:00:00.00Z'
],
'filter' => [
'and' => [
[
'containsAll' => [
'property' => [
'mySpace',
'myContainer',
'myProperty'
],
'values' => [
'1001_1',
'1001_2'
]
]
],
[
'range' => [
'property' => [
'my_space',
'my_container',
'my_weight'
],
'gte' => 0
]
],
[
'equals' => [
'property' => [
'my_space',
'my_view/v1',
'my_severity'
],
'value' => 'CRITICAL'
]
]
]
],
'targetUnits' => [
'unitSystemName' => '<string>'
],
'includeTyping' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate"
payload := strings.NewReader("{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId}/records/aggregate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aggregates\": {\n \"my_groups_by_1d_range\": {\n \"timeHistogram\": {\n \"calendarInterval\": \"1d\",\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"recorded_at\"\n ],\n \"aggregates\": {\n \"my_groups_by_equipment_id\": {\n \"uniqueValues\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"equipment_id\"\n ],\n \"aggregates\": {\n \"my_equipment_daily_temperature_sum\": {\n \"sum\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n },\n \"my_equipment_daily_temperature_maximum\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_daily_temperature_average\": {\n \"avg\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n }\n }\n },\n \"my_temperature_maximum_across_all_readings\": {\n \"max\": {\n \"property\": [\n \"my-space\",\n \"my-container\",\n \"temperature\"\n ]\n }\n }\n },\n \"lastUpdatedTime\": {\n \"gt\": 1705341600000,\n \"lt\": \"2030-05-15T18:00:00.00Z\"\n },\n \"filter\": {\n \"and\": [\n {\n \"containsAll\": {\n \"property\": [\n \"mySpace\",\n \"myContainer\",\n \"myProperty\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_2\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"my_space\",\n \"my_container\",\n \"my_weight\"\n ],\n \"gte\": 0\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"my_space\",\n \"my_view/v1\",\n \"my_severity\"\n ],\n \"value\": \"CRITICAL\"\n }\n }\n ]\n },\n \"targetUnits\": {\n \"unitSystemName\": \"<string>\"\n },\n \"includeTyping\": true\n}"
response = http.request(request)
puts response.read_body{
"aggregates": {
"my_avg_aggregate1": {
"avg": 42
},
"my_terms_aggregate2": {
"uniqueValueBuckets": [
{
"value": "Cognite",
"count": 42,
"aggregates": {
"my_sub_aggregate1": {
"min": 13
},
"my_sub_aggregate2": {
"max": 69
},
"my_sub_aggregate3": {
"uniqueValueBuckets": [
{
"value": "us1",
"count": 42
},
{
"value": "ie1",
"count": 7
}
]
}
}
},
{
"value": "AkerBP",
"count": 21,
"aggregates": {
"my_sub_aggregate1": {
"min": 99
},
"my_sub_aggregate2": {
"max": 999
},
"my_sub_aggregate3": {
"uniqueValueBuckets": [
{
"value": "us1",
"count": 11
}
]
}
}
}
]
}
},
"typing": {}
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}