Search documentation
karat

+

K

User Documentation ↗

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 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 property. To find the API name for your time series property, 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

StreamTimeSeriesPointsRequest
object
Hide children

Hide children

range
union
optional

An absolute or relative range for a time series query.

Show children

Show children

absolute
object
optional

ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.

Show children

Show children

startTime
string
optional
endTime
string
optional
relative
object
optional

A relative time range for a time series query.

Show children

Show children

startTime
object
optional

A relative time, such as "3 days before" or "2 hours after" the current moment.

Show children

Show children

when
string (enum)

Enum values: BEFORE, AFTER

value
integer
unit
string (enum)

Enum values: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

endTime
object
optional

A relative time, such as "3 days before" or "2 hours after" the current moment.

Show children

Show children

when
string (enum)

Enum values: BEFORE, AFTER

value
integer
unit
string (enum)

Enum values: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

Response body

body
string

Success response.

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/objects/employee/50030/timeseries/{property}/streamPoints" \ -d '{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}'