This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Load the geotemporal series entries for a given object's geotemporal series reference property within the specified time range.
Each entry in the response is a map of property names to values, following the same structure as
OntologyObjectV2. Use the additionalProperties field in the request to control which properties are included
in each entry depending on the underlying geotemporal integration.
Results are paginated. Use the nextPageToken from the response to retrieve subsequent pages.
Geotemporal series integrations with only "cold storage" enabled are not supported.
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 API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.
stringThe primary key of the object with the geotemporal series property.
stringThe API name of the geotemporal series property. To find the API name for your property, check the Ontology Manager or use the Get object type endpoint.
stringoptionalThe package RID of the generated SDK.
stringoptionalThe version of the generated SDK.
booleanoptionalA boolean flag that, when set to true, enables the use of beta features in preview mode.
objectThe request body for loading entries from a geotemporal series reference property.
A geotemporal series represents time-indexed geographic observations for an object, such as the location history
of a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same
structure as OntologyObjectV2.
The range field is required and restricts results to a specific time window. Both startTime and endTime
are required on range. The additionalProperties field controls which additional properties appear in each
returned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages.
objectISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.
list<SelectedPropertyApiName>optionalThe additional property API names to include in each entry. The "time" and "position" properties are always included and do not need to be specified here. Use this to request additional geotemporal series metadata properties such as "speed" or "heading". Properties that are not available for the underlying geotemporal integration will be omitted from the response entries.
stringoptionalThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
integeroptionalThe page size to use for the endpoint.
objectSuccess response.
list<GeotemporalSeriesEntry>optionalstringoptionalThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
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/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true" \
-d '{"range":{"startTime":"2020-01-01T00:00:00Z","endTime":"2020-06-01T00:00:00Z"},"additionalProperties":["speed","heading"],"pageSize":100}'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
{
"data": [
{
"time": "2020-03-06T12:00:00Z",
"position": {
"type": "Point",
"coordinates": [
-122.4194,
37.7749
]
},
"speed": 120.5,
"heading": 275.3
},
{
"time": "2020-03-06T13:00:00Z",
"position": {
"type": "Point",
"coordinates": [
-122.4095,
37.7845
]
},
"speed": 95,
"heading": 180
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZQ"
}