Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("fields[0]","subtype")
json.UpdateString("aggregate","uniqueValues")
json.UpdateInt("filter.startTime.max",80468070)
json.UpdateInt("filter.startTime.min",36316784)
json.UpdateInt("filter.endTime.max",41454407)
json.UpdateInt("filter.endTime.min",22256402)
json.UpdateInt("filter.activeAtTime.max",99761365)
json.UpdateInt("filter.activeAtTime.min",19522733)
json.UpdateNewObject("filter.metadata")
json.UpdateInt("filter.assetIds[0]",7366433780129810)
json.UpdateInt("filter.assetIds[1]",4231159671616230)
json.UpdateString("filter.assetExternalIds[0]","laboris amet ex deserunt et")
json.UpdateString("filter.assetExternalIds[1]","Lorem")
json.UpdateInt("filter.rootAssetIds[0].id",123)
json.UpdateString("filter.rootAssetIds[1].externalId","eiusmod exercitation")
json.UpdateInt("filter.assetSubtreeIds[0].id",123)
json.UpdateString("filter.assetSubtreeIds[1].externalId","minim consequat")
json.UpdateString("filter.dataSetIds[0].externalId","m")
json.UpdateInt("filter.dataSetIds[1].id",123)
json.UpdateString("filter.source","proident")
json.UpdateString("filter.type","incididunt anim reprehenderi")
json.UpdateString("filter.subtype","Lo")
json.UpdateInt("filter.createdTime.max",52541729)
json.UpdateInt("filter.createdTime.min",71476601)
json.UpdateInt("filter.lastUpdatedTime.max",55306689)
json.UpdateInt("filter.lastUpdatedTime.min",35839070)
json.UpdateString("filter.externalIdPrefix","ad esse Ut consequat ut")
http.SetRequestHeader("content-type","application/json")
http.SetRequestHeader("api-key","{{api-key}}")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/events/aggregate","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
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}"
}
}
}
