API ReferenceMeasurements

Get Measurement

Retrieve a specific measurement (or sub-measurement) by ID.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

measurement_idstringRequired

Response

Measurement details
idinteger
Measurement identifier
namestring
Measurement name
typeenum

A plain MEASUREMENT is a raw input value; a SUB_CALCULATION (“sub-measurement”) derives its value from a formula over other measurements.

unitobject or nullOptional
The unit this measurement is expressed in, if any.
minimumValuedouble or nullOptional
Minimum allowed value. Only meaningful for type MEASUREMENT.
formulaobjectOptional

The formula driving a SUB_CALCULATION measurement’s quantity. Read-only — there is no API to create or edit a measurement’s formula; it can only be authored in the app. Shape: operands names each referenced measurement ({name, measurementId}); ast is a binary-operation tree (ADD/SUB/MUL/DIV) whose leaves are either {operandRef} (referencing an entry in operands by name) or {constant} (a literal number); sourceText is the original formula text as authored.

isArchivedbooleanOptional
Whether this measurement has been archived.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
502
Bad Gateway Error