IoT Stadium

API Documentation

Telemetry Profile

Telemetry Profile - POST Add Telemetry Profile Comparison

Adds comparison logic for telemetry values (e.g., > 50 = ALERT, < 20 = OK). Useful for triggering states or alerts.

Post
https://api.iotstadium.com/ext/telemetry-profile
    {
      "key": "Content-Type",
      "value": "application/json"
    },
    {
      "key": "Authorization",
      "value": "Bearer {{token}}"
    }

Parameter

Field Type Description
unit String

Unit of your telemetry

conversion_properties Array

Contain the minimum and maximum value for you to convert

telemetry_profile_name String

The name for your telemetry profile

telemetry_profile_type_id Integer

ID for the telemetry profile

{
    "unit": "°K",
    "conversion_properties": {
        "min": null,
        "max": null,
        "conversion_properties": {
            "comparator": "gte",
            "comparison": [
                {
                    "wording": "4",
                    "comparator": "gte",
                    "value": "10"
                }
            ]
        }
    },
    "telemetry_profile_name": "Kelvin",
    "telemetry_profile_type_id": 2
}                                            
{
    "message": "Telemetry Profile created",
    "code": 200
}
{
    "telemetry_profile_name": [
        "The telemetry profile name field is required."
    ],
    "telemetry_profile_type_id": [
        "The telemetry profile type id field is required."
    ],
    "conversion_properties": [
        "The conversion properties field is required."
    ],
    "unit": [
        "The unit field is required."
    ]
}