Skip to main content
GET
Retrieve a data point

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

event_id
string
required

The event's friendly ID (e.g. evt_aBcD1234eFgH5678).

data_point_id
string
required

The data point's friendly ID (e.g. in_aBcD1234eFgH5678).

Response

The data point.

id
string

The data point's friendly ID (e.g. in_aBcD1234eFgH5678).

Example:

"in_aBcD1234eFgH5678"

slug
string

The data point type's slug.

Example:

"feedstock-volume"

data_point_type
string

The data point type's name.

Example:

"Feedstock Volume"

value

Follows the data point type's value_type: a number for number, a string for string and enumeration, and true or false for boolean.

unit
string | null

The data point type's unit, or null when it has none.

Example:

"m3"

status
enum<string>
Available options:
complete,
incomplete,
pending_review,
anomalous
substituted
boolean

A value existed on this data point and a correction replaced it. Stays true after the correction is reverted.

imputed
boolean

No value ever existed on this data point and a correction supplied one. Stays true after the correction is reverted.

raw_value

The value as captured, before any correction. Null on an imputed data point and on one that was never corrected.

substitution
object | null

The data point's most recent correction, or null when it has none. After a revert this is the revert entry. Overrides scoped to a single value stream are not included. The full history is on the corrections endpoint.

rule_results
object[]

Rule alerts on this data point, failing or dismissed results only, latest version per rule.