Skip to main content

SegmentationRequest

oneOf
seriesSeriesNamerequired

A name you make up for the series. Patternode stores nothing else about it, so make it opaque: a hash of your client and asset, not their names.

Possible values: non-empty and <= 200 characters

Example: exu/7f3a9c/1b02e4/export-kw
profileProfile

The segmentation profile, optionally pinned to a version: standard or standard@2026-11. Unpinned, the version current at the call (or, with an edge, the one sealed in it) is used, and the answer names it. Versions never change and are served for at least 24 months. Your onboarding pack names the profiles for your account.

Possible values: Value must match regular expression ^[a-z][a-z0-9-]*(@[0-9]{4}-[0-9]{2})?$

Default value: standard
Examples:
Example: standard
time_unitTimeUnit

The unit of every time in the request and the answer, since the Unix epoch, UTC. In JSON, us and ns times are strings of digits; ms times are integers.

Possible values: [ms, us, ns]

Default value: ms
return_edgeboolean

Also return the edge, to carry on as a forming series.

Default value: false
barsarray[]required

Possible values: >= 2

SegmentationRequest
{
  "series": "exu/7f3a9c/1b02e4/export-kw",
  "profile": "standard",
  "time_unit": "ms",
  "return_edge": false,
  "bars": [
    1730246400000,
    1730249999000,
    412,
    430.5,
    405.2,
    428.1
  ]
}