Stream Values

POST/api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamValues

Warning

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.

Stream all of the points of a time series property (this includes geotime series references).

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: 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.

objectType

string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

primaryKey

string

The primary key of the object with the time series property.

property

string

The API name of the time series backed property. To find the API name, check the Ontology Manager or use the Get object type endpoint.

Query parameters

artifactRepository

string

optional

The repository associated with a marketplace installation.

packageName

string

optional

The package name of the generated SDK.

Request body

StreamTimeSeriesValuesRequest

object

Hide child attributes

range

union

optional

An absolute or relative range for a time series query.

Show child attributes

Response body

body

string

Success response.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/50030/timeseries/{property}/streamValues" \
	-d '{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}'