Field Reference

Identifiers and fields that appear across Open API v2. Each resource page documents its full object.

Identifiers

Identifier	Format	Example	Used in
Organization slug	Lowercase letters, digits, -	yengear	/organizations/{slug}/, X-Organization-Slug
project_id	Letters, digits, _, -	proj_AbCdEfGhIj	/projects/{project_id}/
Device id	Integer	42	{device} and {device_id} path parameters, device_id in export tasks
Device serial_number	Hardware serial (IMEI or SN)	868686000123456	{device} in device routes, Bind a device
Device agri_id	d- prefixed platform ID	d-1000-abcd	Prefix of point agri_id values
Point id	Integer	12	{id} in point routes
Point agri_id	{device_agri_id}-{slave_id}-{address}{data_index}	d-1000-abcd-1-00	Telemetry, history, export factors

Point routes accept only the numeric device id. Device routes accept the id or the serial_number.

Point agri_id

Point	slave_id	address	data_index	agri_id
Temperature	1	0	0	d-1000-abcd-1-00
Humidity	1	1	0	d-1000-abcd-1-10
High word of a 32-bit value	2	12	1	d-1000-abcd-2-121

slave_id and address have no leading zeros, and data_index is a single digit.

Roles

Label	API value
Read-only	readonly
Operator	operator
Manager	manager
Owner	owner

See Authentication.

Point configuration

Field	Description	Example
slave_id	Modbus slave ID	1
address	Register address, 0–65535	0
data_index	Offset for multi-register reads, 0–9	0
modbus_type	0 unknown, 1 coil, 2 discrete input, 3 holding register, 4 input register	3
data_type	int8, uint16, int16, uint32, int32, float32, f32_2_i16	int16
data_endian	@ auto, > ABCD, < DCBA, <_SB BADC, <_SW CDAB	>
data_scale	Value = raw × data_scale + data_delta	0.1
data_delta	Offset added after scaling	-10
the_type	Point type ID from List configuration options	1
the_type_detail	Type name, unit, value type, and icon	{ "name": "Temperature", "unit": "℃" }

Data fields

Field	Description	Appears in
t	Observation time, Unix seconds (UTC)	Live data, history, reported data
value	Reading	Live data, reported data
v	Reading	Point history
project_id	Project of the reading	Live data, reported data
org_slug	Organization slug of the reading	Live data
org_id	Organization slug of the reading (despite the name)	Response of Report device data

Time fields

Kind	Format	Examples
Date-time	ISO 8601 string	created_at, bind_time, connect_time, expires_at
Telemetry and ranges	Integer Unix seconds	t, min_timestamp, start_time, end_time