Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Aggregate Object Set

POST/api/v2/ontologies/{ontology}/objectSets/aggregate

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.

Path parameters

ontology
string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

Query parameters

sdkPackageRid
string
optional

The package rid of the generated SDK.

sdkVersion
string
optional

The package version of the generated SDK.

branch
string
optional

The Foundry branch to aggregate the objects from. If not specified, the default branch is used.

Request body

AggregateObjectSetRequestV2
object
Hide child attributes

Hide child attributes

aggregation
list<AggregationV2>
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the Ontology.

Show child attributes

Show child attributes

groupBy
list<AggregationGroupByV2>
optional
Show child attributes

Show child attributes

accuracy
string (enum)
optional

Enum values: REQUIRE_ACCURATE, ALLOW_APPROXIMATE

Response body

AggregateObjectsResponseV2
object

Success response.

Hide child attributes

Hide child attributes

excludedItems
integer
optional
accuracy
string (enum)

Enum values: ACCURATE, APPROXIMATE

data
list<AggregateObjectsResponseItemV2>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
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 ''

Response

Copied!
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" } } ] }