Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "fields": [
# "subtype"
# ],
# "aggregate": "uniqueValues",
# "filter": {
# "startTime": {
# "max": 80468070,
# "min": 36316784
# },
# "endTime": {
# "max": 41454407,
# "min": 22256402
# },
# "activeAtTime": {
# "max": 99761365,
# "min": 19522733
# },
# "metadata": {},
# "assetIds": [
# 7366433780129810,
# 4231159671616230
# ],
# "assetExternalIds": [
# "laboris amet ex deserunt et",
# "Lorem"
# ],
# "rootAssetIds": [
# {
# "id": 5301845202166120
# },
# {
# "externalId": "eiusmod exercitation"
# }
# ],
# "assetSubtreeIds": [
# {
# "id": 532532664250766
# },
# {
# "externalId": "minim consequat"
# }
# ],
# "dataSetIds": [
# {
# "externalId": "m"
# },
# {
# "id": 7462419378685606
# }
# ],
# "source": "proident",
# "type": "incididunt anim reprehenderi",
# "subtype": "Lo",
# "createdTime": {
# "max": 52541729,
# "min": 71476601
# },
# "lastUpdatedTime": {
# "max": 55306689,
# "min": 35839070
# },
# "externalIdPrefix": "ad esse Ut consequat ut"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "fields[0]" "subtype"
CkJsonObject_UpdateString $json "aggregate" "uniqueValues"
CkJsonObject_UpdateInt $json "filter.startTime.max" 80468070
CkJsonObject_UpdateInt $json "filter.startTime.min" 36316784
CkJsonObject_UpdateInt $json "filter.endTime.max" 41454407
CkJsonObject_UpdateInt $json "filter.endTime.min" 22256402
CkJsonObject_UpdateInt $json "filter.activeAtTime.max" 99761365
CkJsonObject_UpdateInt $json "filter.activeAtTime.min" 19522733
CkJsonObject_UpdateNewObject $json "filter.metadata"
CkJsonObject_UpdateInt $json "filter.assetIds[0]" 7366433780129810
CkJsonObject_UpdateInt $json "filter.assetIds[1]" 4231159671616230
CkJsonObject_UpdateString $json "filter.assetExternalIds[0]" "laboris amet ex deserunt et"
CkJsonObject_UpdateString $json "filter.assetExternalIds[1]" "Lorem"
CkJsonObject_UpdateInt $json "filter.rootAssetIds[0].id" 123
CkJsonObject_UpdateString $json "filter.rootAssetIds[1].externalId" "eiusmod exercitation"
CkJsonObject_UpdateInt $json "filter.assetSubtreeIds[0].id" 123
CkJsonObject_UpdateString $json "filter.assetSubtreeIds[1].externalId" "minim consequat"
CkJsonObject_UpdateString $json "filter.dataSetIds[0].externalId" "m"
CkJsonObject_UpdateInt $json "filter.dataSetIds[1].id" 123
CkJsonObject_UpdateString $json "filter.source" "proident"
CkJsonObject_UpdateString $json "filter.type" "incididunt anim reprehenderi"
CkJsonObject_UpdateString $json "filter.subtype" "Lo"
CkJsonObject_UpdateInt $json "filter.createdTime.max" 52541729
CkJsonObject_UpdateInt $json "filter.createdTime.min" 71476601
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.max" 55306689
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.min" 35839070
CkJsonObject_UpdateString $json "filter.externalIdPrefix" "ad esse Ut consequat ut"
CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/v1/projects/{{project}}/events/aggregate" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"fields": [
"subtype"
],
"aggregate": "uniqueValues",
"filter": {
"startTime": {
"max": 80468070,
"min": 36316784
},
"endTime": {
"max": 41454407,
"min": 22256402
},
"activeAtTime": {
"max": 99761365,
"min": 19522733
},
"metadata": {},
"assetIds": [
7366433780129810,
4231159671616230
],
"assetExternalIds": [
"laboris amet ex deserunt et",
"Lorem"
],
"rootAssetIds": [
{
"id": 5301845202166120
},
{
"externalId": "eiusmod exercitation"
}
],
"assetSubtreeIds": [
{
"id": 532532664250766
},
{
"externalId": "minim consequat"
}
],
"dataSetIds": [
{
"externalId": "m"
},
{
"id": 7462419378685606
}
],
"source": "proident",
"type": "incididunt anim reprehenderi",
"subtype": "Lo",
"createdTime": {
"max": 52541729,
"min": 71476601
},
"lastUpdatedTime": {
"max": 55306689,
"min": 35839070
},
"externalIdPrefix": "ad esse Ut consequat ut"
}
}'
https://domain.com/api/v1/projects/{{project}}/events/aggregate
Postman Collection Item JSON
{
"id": "aggregateEvents",
"name": "Aggregate events",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"events",
"aggregate"
],
"query": [
],
"variable": [
]
},
"method": "POST",
"header": [
{
"key": "api-key",
"value": "{{api-key}}",
"description": "An admin can create API keys in the Cognite console."
},
{
"key": "content-type",
"value": "application/json"
}
],
"description": "The aggregation API allows you to compute aggregated results on events \nlike getting the count of all events in a project or checking what are all the \ndifferent types and subtypes of events in your project, along with \nthe count of events in each of those aggregations. By specifying an additional \nfilter, you can also aggregate only among events matching the specified filter.\n\nThe default behavior, when you do not specify \nthe `aggregate` field in the request body, is to return the count \nof events.\n\nSetting `aggregate` to `uniqueValues` will return all unique values (up to a \nmaximum of 1000) and the count of each in the field specified in \n`fields: []`. Note that, currently, you can only request for unique \nvalues on a single field. Also, in the case of text fields, the values are \naggregated in a case-insensitive manner. For example:\n\n```\n{\n \"aggregate\": \"uniqueValues\",\n \"fields\": [ \"type\" ]\n}\n```\n\nwill return all unique 'types' in the events in your project.\n\nSimilarly,\n\n```\n{\n \"aggregate\": \"uniqueValues\",\n \"fields\": [ \"dataSetId\" ],\n \"filter\": {\n \"subType\": \"subtype_1\"\n }\n}\n```\nwill return all unique dataSetIds in events of subtype 'subtype_1'\n",
"body": {
"mode": "raw",
"raw": "{\n \"fields\": [\n \"subtype\"\n ],\n \"aggregate\": \"uniqueValues\",\n \"filter\": {\n \"startTime\": {\n \"max\": 80468070,\n \"min\": 36316784\n },\n \"endTime\": {\n \"max\": 41454407,\n \"min\": 22256402\n },\n \"activeAtTime\": {\n \"max\": 99761365,\n \"min\": 19522733\n },\n \"metadata\": {},\n \"assetIds\": [\n 7366433780129810,\n 4231159671616230\n ],\n \"assetExternalIds\": [\n \"laboris amet ex deserunt et\",\n \"Lorem\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 5301845202166120\n },\n {\n \"externalId\": \"eiusmod exercitation\"\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 532532664250766\n },\n {\n \"externalId\": \"minim consequat\"\n }\n ],\n \"dataSetIds\": [\n {\n \"externalId\": \"m\"\n },\n {\n \"id\": 7462419378685606\n }\n ],\n \"source\": \"proident\",\n \"type\": \"incididunt anim reprehenderi\",\n \"subtype\": \"Lo\",\n \"createdTime\": {\n \"max\": 52541729,\n \"min\": 71476601\n },\n \"lastUpdatedTime\": {\n \"max\": 55306689,\n \"min\": 35839070\n },\n \"externalIdPrefix\": \"ad esse Ut consequat ut\"\n }\n}"
}
}
}
