Perform functions on object fields in the specified ontology and object type.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.
stringThe API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.
stringThe type of the object to aggregate on.
stringThe package rid of the generated SDK.
stringThe version of the generated SDK.
stringThe Foundry branch to aggregate objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.
objectlist<AggregationV2>unionlist<AggregationGroupByV2>string (enum)Specifies the accuracy requirement for aggregation results.
REQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be
guaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail
with an AggregationAccuracyNotSupported error.ALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the
default behavior if not specified.Enum values: REQUIRE_ACCURATE, ALLOW_APPROXIMATE
objectSuccess response.
integerstring (enum)Enum values: ACCURATE, APPROXIMATE
list<AggregateObjectsResponseItemV2>numberA measurement of compute usage expressed in compute-seconds. For more information, please refer to the Usage types documentation.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
-d '{"aggregation":[{"type":"min","field":"tenure","name":"min_tenure"},{"type":"avg","field":"tenure","name":"avg_tenure"}],"where":{"type":"eq","field":"name","value":"john"},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"data": [
{
"metrics": [
{
"name": "min_tenure",
"value": 1
},
{
"name": "avg_tenure",
"value": 3
}
],
"group": {
"startDate": {
"startValue": "2020-01-01",
"endValue": "2020-06-01"
},
"city": "New York City"
}
},
{
"metrics": [
{
"name": "min_tenure",
"value": 2
},
{
"name": "avg_tenure",
"value": 3
}
],
"group": {
"startDate": {
"startValue": "2020-01-01",
"endValue": "2020-06-01"
},
"city": "San Francisco"
}
}
]
}