Aggregates the ontology objects present in the ObjectSet
from the provided object set definition.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read
.
string
The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
string
The package rid of the generated SDK.
string
The package version of the generated SDK.
string
The Foundry branch to aggregate the objects from. If not specified, the default branch is used.
object
list<AggregationV2>
union
Represents the definition of an ObjectSet
in the Ontology
.
list<AggregationGroupByV2>
string
(enum)Enum values: REQUIRE_ACCURATE
, ALLOW_APPROXIMATE
object
Success response.
integer
string
(enum)Enum values: ACCURATE
, APPROXIMATE
list<AggregateObjectsResponseItemV2>
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/aggregate?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
-d ''
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"
}
}
]
}