Stream Points

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

Stream all of the points of a time series property.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontology

string

The API name or RID of the Ontology. To find the API name or RID, 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 property. To find the API name for your time series property, check the Ontology Manager or use the Get object type endpoint.

Query parameters

sdkPackageRid

string

optional

The package rid of the generated SDK.

sdkVersion

string

optional

The version of the generated SDK.

format

string (enum)

optional

The output format to serialize the output binary stream in. Default is JSON. ARROW is more efficient than JSON at streaming a large sized response.

Enum values: JSON, ARROW

Request body

StreamTimeSeriesPointsRequest

object

Hide child attributes

range

union

optional

An absolute or relative range for a time series query.

Show child attributes

aggregate

object

optional

Show child attributes

Response body

body

string

Success response.

Examples

Request

Copied!

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