Skip to main content
GET
Get a machine variable

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Path Parameters

id
string
required
Example:

"mvr_01kae7a2kpkcqwy7fwk2fft11h"

Response

Machine variable

id
string
required

Unique identifier of the machine variable.

Example:

"mvr_01kae7a2kpkcqwy7fwk2fft11h"

name
string
required

Human-readable name of the machine variable.

Example:

"retentate outlet flow rate"

unit
string | null
required

Unit of the measured values. Null means the value is unitless.

Example:

"m3/h"

machine_id
string
required

The machine this variable belongs to.

Example:

"mch_01kqzcjrpyf27tge7875y20mmr"

value_type
enum<string>
required

Type that values of this variable must conform to when ingesting machine data. Variables of type string, date_time or text cannot receive imports.

Available options:
int8,
int16,
int32,
int64,
uint8,
uint16,
uint32,
uint64,
float,
double,
boolean,
string,
date_time,
text
Example:

"float"

timestamp_precision
enum<string>
required

Effective storage precision of ingested timestamps. Sub-second fractions are truncated for seconds variables; two values with the same effective timestamp overwrite each other.

Available options:
seconds,
milliseconds
Example:

"seconds"

factor
number | null
required

Factor applied to raw values during ingestion.

Example:

1