get annotations based on a sliding window

Path Params

string

required

Id of the timeseries package to aggregate annotations for

layerId

int32

required

Id of the layer the annotations belongs to

Query Params

aggregation

string

enum

required

Aggregation function to run over the values of the annotations

Allowed:

start

int64

required

The starting time of the range to query over in microseconds (inclusive)

end

int64

required

The ending time of the the range to query over in microseconds (exclusive)

period

int64

required

The length of time to group the counts of annotations by in microseconds

channelIds

array of strings

list of channel ids (if absent, use all channels)

channelIds

mergePeriods

boolean

Defaults to false

merge consecutive result periods together to reduce the size of the resulting payload

startAtEpoch

boolean

Defaults to false

Returned timestamps will be relative to the minimum package time

200OK