IoT Data (Waygo) API

This endpoint retrieves historical IoT data records for assets. It allows filtering by various criteria including timestamp ranges and names to analyze sensor readings and asset status over time.

Base URL

All requests to the IoT Data API should be made to the following endpoint:

GET https://paas-uat.v3nity.com/api/resource/track/data/iotdata

Authentication

This API supports two methods of authentication. You must include your credentials in the Authorization header of every request. The tenant context is automatically derived from your credentials.

1. API Key Authentication

Include your unique API key directly in the header.

Authorization: <YOUR_API_KEY>

2. Bearer Token Authentication

Use a JWT access token obtained from the login endpoint, prefixed with Bearer.

Authorization: Bearer <YOUR_ACCESS_TOKEN>

Request Parameters

All parameters are passed as query strings. To perform a range query (e.g., for timestamps), repeat the parameter with gte: (Greater Than or Equal) and lte: (Lesser Than or Equal) prefixes.

Parameter	Type	Status	Description
`timestamp`	datetime	Mandatory	Filters records by the device-reported time. Format: `YYYY-MM-DDTHH:mm:ss.SSSZ` Range Example: `?timestamp=gte:2025-07-08T00:00:00.000Z×tamp=lte:2025-07-08T23:00:00.000Z`
`create_time`	datetime	Optional	Filter by the record creation time (UTC ISO 8601).
`tenant_name`	nvarchar(100)	Optional	Filter by tenant name.
`asset_name`	nvarchar(100)	Optional	Filter by asset name.
`asset_type_name`	nvarchar(100)	Optional	Filter by asset category.
`description`	nvarchar(100)	Optional	Filter by asset description.
`asset_location_name`	nvarchar(200)	Optional	Filter by the name of the asset location.
Sensor Data (Dynamic)
`data.Frequency`	String	Optional	Frequency
`data.Vb`	Float	Optional	Converted Vb [m3]
`data.Vm`	Float	Optional	Unconverted Vm [m3]
`data.P`	Float	Optional	Pressure P [bar]
`data.T`	Float	Optional	Temperature T [°C]
`data.Vbdh_T`	Float	Optional	Total Vb+Vbs hr Vbdh_T [m3]
`data.Vbdh`	Float	Optional	Vd in hour Vbdh [m3]
`data.Vbsdh`	Float	Optional	Vbs in hour Vbsdh [m3]
`data.Vmdh`	Float	Optional	Vm in hour Vmdh [m3]
`data.Vsdh`	Float	Optional	Vs in hour Vsdh [m3]
`data.Vmdh_N`	Float	Optional	Vm norm. cond hr Vmdh_N [m3]
`data.Vbdd_T`	Float	Optional	Total Vb+Vbs hr Vbdd_T [m3]
`data.BV`	Float	Optional	Battery voltage BV [V]
`data.BC`	Float	Optional	Battery capacity BC [%]
`data.Q`	Float	Optional	Flow Q [m3/h]
`data.Qb`	Float	Optional	Base flow Qb [m3/h]
`data.Pmax`	Float	Optional	Max Pressure Pmax [bar]
`data.T_Pmax`	String	Optional	Max Pressure Time T_Pmax
`data.Pmin`	Float	Optional	Min Pressure Pmin [bar]
`data.T_Pmin`	String	Optional	Min Pressure Time T_Pmin
`data.Tmax`	Float	Optional	Max Temperature Tmax [°C]
`data.T_Tmax`	String	Optional	Max Temperature Time T_Tmax
`data.Tmin`	Float	Optional	Min Temperature Tmin [°C]
`data.T_Tmin`	String	Optional	Min Temperature Time T_Tmin
`data.Qmax`	Float	Optional	Max Flow Qmax [m3/h]
`data.T_Qmax`	String	Optional	Max Flow Time T_Qmax
`data.Qmin`	Float	Optional	Min Flow Qmin [m3/h]
`data.T_Qmin`	String	Optional	Min Flow Time T_Qmin
`data.Qbmax`	Float	Optional	Max Base Flow Qbmax [m3/h]
`data.T_Qbmax`	String	Optional	Max Base Flow Qbmax Time
`data.Qbmin`	Float	Optional	Min Base Flow Qbmin [m3/h]
`data.T_Qbmin`	String	Optional	Min Base Flow Qbmin Time
`data.BC_iot`	Integer	Optional	Battery Capacity IOT

Request Example

Querying for a specific asset within a 24-hour range:

GET https://paas-uat.v3nity.com/api/resource/track/data/iotdata?timestamp=gte:2025-07-08T00:00:00.000Z×tamp=lte:2025-07-08T23:00:00.000Z&asset_name=Test%20Device

cURL Examples

Using Bearer Token

curl -X GET "https://paas-uat.v3nity.com/api/resource/track/data/iotdata?timestamp=gte:2025-07-08T00:00:00.000Z&timestamp=lte:2025-07-08T23:00:00.000Z&asset_name=Test%20Device" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

Using API Key

curl -X GET "https://paas-uat.v3nity.com/api/resource/track/data/iotdata?timestamp=gte:2025-07-08T00:00:00.000Z&timstamp=lte:2025-07-08T23:00:00.000Z&asset_name=Test%20Device" -H "Authorization: <YOUR_API_KEY>"

Response Fields

Field	Type	Description
`create_time`	datetime	The server-side timestamp when the record was created (UTC ISO 8601).
`timestamp`	datetime	The actual timestamp reported by the IoT device (UTC ISO 8601).
`tenant_name`	nvarchar(100)	The name of the tenant owning the asset.
`asset_name`	nvarchar(100)	The display name of the asset.
`asset_type_name`	nvarchar(100)	The category or type of the asset (e.g., Waste Bin).
`description`	nvarchar(100)	Detailed description of the asset.
`asset_location_name`	nvarchar(200)	The name of the location where the asset is deployed.
Sensor Data (Dynamic)
`data.Frequency`	String	Frequency
`data.Vb`	Float	Converted Vb [m3]
`data.Vm`	Float	Unconverted Vm [m3]
`data.P`	Float	Pressure P [bar]
`data.T`	Float	Temperature T [°C]
`data.Vbdh_T`	Float	Total Vb+Vbs hr Vbdh_T [m3]
`data.Vbdh`	Float	Vd in hour Vbdh [m3]
`data.Vbsdh`	Float	Vbs in hour Vbsdh [m3]
`data.Vmdh`	Float	Vm in hour Vmdh [m3]
`data.Vsdh`	Float	Vs in hour Vsdh [m3]
`data.Vmdh_N`	Float	Vm norm. cond hr Vmdh_N [m3]
`data.Vbdd_T`	Float	Total Vb+Vbs hr Vbdd_T [m3]
`data.BV`	Float	Battery voltage BV [V]
`data.BC`	Float	Battery capacity BC [%]
`data.Q`	Float	Flow Q [m3/h]
`data.Qb`	Float	Base flow Qb [m3/h]
`data.Pmax`	Float	Max Pressure Pmax [bar]
`data.T_Pmax`	String	Max Pressure Time T_Pmax
`data.Pmin`	Float	Min Pressure Pmin [bar]
`data.T_Pmin`	String	Min Pressure Time T_Pmin
`data.Tmax`	Float	Max Temperature Tmax [°C]
`data.T_Tmax`	String	Max Temperature Time T_Tmax
`data.Tmin`	Float	Min Temperature Tmin [°C]
`data.T_Tmin`	String	Min Temperature Time T_Tmin
`data.Qmax`	Float	Max Flow Qmax [m3/h]
`data.T_Qmax`	String	Max Flow Time T_Qmax
`data.Qmin`	Float	Min Flow Qmin [m3/h]
`data.T_Qmin`	String	Min Flow Time T_Qmin
`data.Qbmax`	Float	Max Base Flow Qbmax [m3/h]
`data.T_Qbmax`	String	Max Base Flow Qbmax Time
`data.Qbmin`	Float	Min Base Flow Qbmin [m3/h]
`data.T_Qbmin`	String	Min Base Flow Qbmin Time
`data.BC_iot`	Integer	Battery Capacity IOT

Response Example

Sample response for a query within the range 2025-07-08T00:00:00.000Z to 2025-07-08T23:00:00.000Z:

[
  {
    "create_time": "2025-07-08T08:00:05.123Z",
    "timestamp": "2025-07-08T08:00:00.000Z",
    "tenant_name": "V3 Smart Tech",
    "asset_name": "Test Device",
    "asset_type_name": "Waste Bin",
    "description": "General Waste Bin at Sector 1",
    "asset_location_name": "Sector 1 Entrance",
    "data.Frequency": "Daily",
    "data.P": 1.25,
    "data.T": 28.5,
    "data.BC": 92.0
  },
  {
    "create_time": "2025-07-08T09:00:10.456Z",
    "timestamp": "2025-07-08T09:00:00.000Z",
    "tenant_name": "V3 Smart Tech",
    "asset_name": "Bin-B2",
    "asset_type_name": "Recycle Bin",
    "description": "Recycle Bin at Sector 2",
    "asset_location_name": "Sector 2 Parking",
    "data.Frequency": "Daily",
    "data.P": 1.18,
    "data.T": 29.1,
    "data.BC": 88.5
  }
]

ℹ️

Note on Date Ranges

To filter by a range, provide the same parameter twice in the URL: once with the gte: prefix for the start time, and once with the lte: prefix for the end time.