const aggregates = await client.files.aggregate({ filter: { uploaded: true } });
console.log('Number of uploaded files: ', aggregates[0].count)aggregate_uploaded = client.files.aggregate(filter={"uploaded": True})Aggregate fileAggregate =
client.files().aggregate(Request.create()
.withFilterParameter("source", "source"));curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"directoryPrefix": "/my/known/directory",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetExternalIds": [
"externalId1",
"externalId2",
"externalId3"
],
"rootAssetIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"assetSubtreeIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"source": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"uploadedTime": {
"max": 1,
"min": 1
},
"sourceCreatedTime": {
"max": 1,
"min": 1
},
"sourceModifiedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix",
"uploaded": true,
"labels": {
"containsAny": [
{
"externalId": "my.known.id"
}
]
}
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/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([
'filter' => [
'name' => '<string>',
'directoryPrefix' => '/my/known/directory',
'mimeType' => 'image/jpeg',
'metadata' => [
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetExternalIds' => [
'externalId1',
'externalId2',
'externalId3'
],
'rootAssetIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'assetSubtreeIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'source' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'uploadedTime' => [
'max' => 1,
'min' => 1
],
'sourceCreatedTime' => [
'max' => 1,
'min' => 1
],
'sourceModifiedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix',
'uploaded' => true,
'labels' => [
'containsAny' => [
[
'externalId' => 'my.known.id'
]
]
]
]
]),
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}/files/aggregate"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/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 \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"count": 1
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Required capabilities:
filesAcl:READ
Calculate aggregates for files, based on optional filter specification.
Returns the following aggregates: count
Request throttling
This endpoint is intended for data analytics and exploration purposes. It is not designed to support high-throughput data retrieval. Please note that this endpoint is subject to the new throttling policy, which imposes limits on both request rate and concurrency. For more details, please refer to the Files resource documentation.
const aggregates = await client.files.aggregate({ filter: { uploaded: true } });
console.log('Number of uploaded files: ', aggregates[0].count)aggregate_uploaded = client.files.aggregate(filter={"uploaded": True})Aggregate fileAggregate =
client.files().aggregate(Request.create()
.withFilterParameter("source", "source"));curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"directoryPrefix": "/my/known/directory",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetExternalIds": [
"externalId1",
"externalId2",
"externalId3"
],
"rootAssetIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"assetSubtreeIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"source": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"uploadedTime": {
"max": 1,
"min": 1
},
"sourceCreatedTime": {
"max": 1,
"min": 1
},
"sourceModifiedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix",
"uploaded": true,
"labels": {
"containsAny": [
{
"externalId": "my.known.id"
}
]
}
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/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([
'filter' => [
'name' => '<string>',
'directoryPrefix' => '/my/known/directory',
'mimeType' => 'image/jpeg',
'metadata' => [
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetExternalIds' => [
'externalId1',
'externalId2',
'externalId3'
],
'rootAssetIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'assetSubtreeIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'source' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'uploadedTime' => [
'max' => 1,
'min' => 1
],
'sourceCreatedTime' => [
'max' => 1,
'min' => 1
],
'sourceModifiedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix',
'uploaded' => true,
'labels' => [
'containsAny' => [
[
'externalId' => 'my.known.id'
]
]
]
]
]),
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}/files/aggregate"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/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 \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"count": 1
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
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
Files aggregate request body
Filter on files with exact match
Show child attributes
Show child attributes
Response
Response with files aggregates.
Show child attributes
Show child attributes
Was this page helpful?