Create time series

post

https://data.api.exabel.com/v1/entityTypes/{entityTypeId}/entities/{entityId}/signals/{signalId}

Note: Exabel only supports processing time series with daily or lower resolution. Timestamps must be RFC 3339 timestamps, normalised to midnight UTC, e.g. 2020-01-01T00:00:00Z.

The default knownTime for a data point is insertion time, i.e. same as setting currentTime to true. To override the default behaviour, set one of the defaultKnownTime fields.

The optional view argument lets you request for time series data points to be returned within a date range. If this is not set, no values are returned.

It is also possible to create a time series by calling UpdateTimeSeries with allowMissing set to true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityTypeId

string

required

The ID of an entity type, e.g. entityTypeIdentifier or namespace.entityTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity type identifier must match the regex \w[\w-]{0,63}.

entityId

string

required

The ID of an entity, e.g. entityIdentifier or namespace.entityIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity identifier must match the regex \w[\w-]{0,63}.

signalId

string

required

The ID of a signal, e.g. signalIdentifier or namespace.signalIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The signal identifier must match the regex [a-zA-Z]\w{0,63}.

Query Params

view.timeRange.fromTime

date-time

Start of the time range, included in the range by default.

view.timeRange.excludeFrom

boolean

Set to true to exclude the start point from the range.

view.timeRange.toTime

date-time

End of the time range, excluded from the range by default.

view.timeRange.includeTo

boolean

Set to true to include the end point in the range.

view.knownTime

date-time

Specifies that the time series should be returned as it was known at this time (in the past). Data points known after this time are disregarded. If not set, the latest data points are returned.

insertOptions.defaultKnownTime.currentTime

boolean

Specifies the current system time as the default known time for all inserted data points.

insertOptions.defaultKnownTime.knownTime

date-time

Specifies a specific timestamp as the default known time for all inserted data points.

insertOptions.defaultKnownTime.timeOffset

string

Specifies a time offset from each data point's timestamp to be its default known time in seconds. Formatted as a signed number with the suffix s.

insertOptions.createTag

boolean

This field is not in use anymore.

insertOptions.shouldOptimise

boolean

Whether time series storage optimisation should be enabled or not. If not set, optimisation is at the discretion of the server.

defaultKnownTime.currentTime

boolean

Specifies the current system time as the default known time for all inserted data points.

defaultKnownTime.knownTime

date-time

Specifies a specific timestamp as the default known time for all inserted data points.

defaultKnownTime.timeOffset

string

Specifies a time offset from each data point's timestamp to be its default known time.

createTag

boolean

This field is not in use anymore.

shouldOptimise

boolean

This field is deprecated and replaced with insert_options.should_optimise.

Body Params

The time series to create.

points

array of objects

List of time series data points. Data points are always returned by Exabel in chronological order (earliest first).

points

units

object

The units of a time series. Not all time series have known units, in which case its units field is not present. If present, but empty, the unit of the time series is known to be dimensionless and unscaled.

Responses

200A successful response.

defaultAn unexpected error response.