Aggregate Simulator Routines
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aggregate": "count",
"filter": {
"modelExternalIds": [
"model_1",
"model_2"
],
"simulatorIntegrationExternalIds": [
"simulator_integration_1",
"simulator_integration_2"
],
"simulatorExternalIds": [
"PROSPER",
"PetroSIM"
]
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/aggregate"
payload = {
"aggregate": "count",
"filter": {
"modelExternalIds": ["model_1", "model_2"],
"simulatorIntegrationExternalIds": ["simulator_integration_1", "simulator_integration_2"],
"simulatorExternalIds": ["PROSPER", "PetroSIM"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aggregate: 'count',
filter: {
modelExternalIds: ['model_1', 'model_2'],
simulatorIntegrationExternalIds: ['simulator_integration_1', 'simulator_integration_2'],
simulatorExternalIds: ['PROSPER', 'PetroSIM']
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/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}/simulators/routines/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([
'aggregate' => 'count',
'filter' => [
'modelExternalIds' => [
'model_1',
'model_2'
],
'simulatorIntegrationExternalIds' => [
'simulator_integration_1',
'simulator_integration_2'
],
'simulatorExternalIds' => [
'PROSPER',
'PetroSIM'
]
]
]),
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}/simulators/routines/aggregate"
payload := strings.NewReader("{\n \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\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}/simulators/routines/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/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 \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"count": 123
}
]
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}Aggregate Simulator Routines
Calculate aggregates for simulator routines, considering the optional filter specification.
POST
/
simulators
/
routines
/
aggregate
Aggregate Simulator Routines
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aggregate": "count",
"filter": {
"modelExternalIds": [
"model_1",
"model_2"
],
"simulatorIntegrationExternalIds": [
"simulator_integration_1",
"simulator_integration_2"
],
"simulatorExternalIds": [
"PROSPER",
"PetroSIM"
]
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/aggregate"
payload = {
"aggregate": "count",
"filter": {
"modelExternalIds": ["model_1", "model_2"],
"simulatorIntegrationExternalIds": ["simulator_integration_1", "simulator_integration_2"],
"simulatorExternalIds": ["PROSPER", "PetroSIM"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aggregate: 'count',
filter: {
modelExternalIds: ['model_1', 'model_2'],
simulatorIntegrationExternalIds: ['simulator_integration_1', 'simulator_integration_2'],
simulatorExternalIds: ['PROSPER', 'PetroSIM']
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/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}/simulators/routines/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([
'aggregate' => 'count',
'filter' => [
'modelExternalIds' => [
'model_1',
'model_2'
],
'simulatorIntegrationExternalIds' => [
'simulator_integration_1',
'simulator_integration_2'
],
'simulatorExternalIds' => [
'PROSPER',
'PetroSIM'
]
]
]),
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}/simulators/routines/aggregate"
payload := strings.NewReader("{\n \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\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}/simulators/routines/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/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 \"aggregate\": \"count\",\n \"filter\": {\n \"modelExternalIds\": [\n \"model_1\",\n \"model_2\"\n ],\n \"simulatorIntegrationExternalIds\": [\n \"simulator_integration_1\",\n \"simulator_integration_2\"\n ],\n \"simulatorExternalIds\": [\n \"PROSPER\",\n \"PetroSIM\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"count": 123
}
]
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}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.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Last modified on August 21, 2026
⌘I