Innon Cloud API (beta) (0.0.1)

Download OpenAPI specification:Download

Contact our support: support@innon.co.uk URL: https://www.innon.com Terms of Service

Introduction

Welcome to the Innon Cloud API (beta) documentation.

The Innon Cloud API is designed to provide seamless access to your data stored in our cloud warehouse. With this API, you can efficiently and reliably retrieve your data. The API's functionalities include:

Site-Specific Data Access: Retrieve data on a per-site, per-day basis, allowing you to focus on specific locations and time frames to get the exact data you need.
Enhanced BI Data Access: Leverage the API to access enriched business intelligence (BI) data, enabling an easier format for visualisations and detailed analysis.
Data Statistics: Gain valuable statistics about your data, helping you understand trends, identify anomalies, and monitor performance over time.

Please note that the Innon Cloud API is currently in its beta phase. This means that while the core functionalities are fully operational, the API is still undergoing testing and refinement. During this beta period, you may encounter minor bugs or unexpected behavior. We are actively working on improvements and would greatly appreciate any feedback you can provide to help us enhance the API. As a beta user, you have the unique opportunity to influence the final version of the API by sharing your experiences, reporting any issues, and suggesting features that could improve your workflow. Your input is invaluable in making the INNON API a robust and reliable tool for all users. Thank you for your understanding and support during this beta phase!

Below, we list the currently available endpoints with a brief description of their functionality.

Locations

Retrieve Available Locations

This endpoint retrieves all available locations for an authenticated user. The information returned can be used to access or filter data in other endpoints.

Authorization

To access this endpoint, you must include an AuthorizationToken in the header of your request. The token is provided by the system and must be valid.

Key Features:

Location Data: Returns a list of locations, each containing a site name, deviceId, and siteId.

Use this endpoint to get location-specific information that will help you filter data for other API requests.

Authorizations:

None

header Parameters

AuthorizationToken

required

string

Example: abc123def456ghi789jkl012mn

A valid token provided by the system to authenticate the user. This token is required to access the endpoint.

Responses

Response samples

200
401
404

Content type

application/json

{"status": "success",
"locations": [{"site": "Andy's House",
"deviceId": "1514ff18-b85d-41v2-236z-6716d6c7d83f",
"siteId": "5e1b2d0z-c870c50i"
}
]
}

Data

Retrieve Haystack Tagged Data for a Specific Date and Site

This endpoint retrieves Haystack tagged data for a specified date and location siteId.

Authorization

To access this endpoint, you must include an AuthorizationToken header in your request. The AuthorizationToken is a 25-character alphanumeric code provided by the Innon team. Ensure that this token is kept secure and is included in every request.

Key Features:

Date-Specific Data: Retrieve data for a specific date by providing the date query parameter.
Site-Specific Data: Use the siteId parameter to specify the site from which you want to retrieve data.

Use this endpoint to integrate data into your systems for monitoring, analysis, or reporting purposes.

Authorizations:

None

query Parameters

date required	string <date> Example: date=2024-09-01 The date for which you want to retrieve the data. The format should be `YYYY-MM-DD`.
siteId required	string Example: siteId=example-site-id-1234 Unique identifier for the site from which you want to retrieve the data.

header Parameters

AuthorizationToken

required

string

Example: exampleAuthToken1234567890abcd

A 25-character alphanumeric token provided by the Innon team. This token is required to authenticate your requests.

Responses

Response samples

200
400
401
404

Content type

application/json

[[{"_kind": "grid",
"meta": {"ver": "3.0",
"view": "chart",
"hisStart": {"_kind": "dateTime",
"val": "2024-08-24T00:00:00+01:00",
"tz": "UTC"
},
"hisEnd": {"_kind": "dateTime",
"val": "2024-08-25T00:00:00+01:00",
"tz": "UTC"
},
"hisLimit": 10000,
"dis": "Sample Display Description"
},
"cols": [{"name": "ts",
"meta": {"disKey": "ui::timestamp",
"tz": "UTC",
"chartFormat": "ka",
"mod": {"_kind": "dateTime",
"val": "2024-08-23T16:26:13.954Z",
"tz": "UTC"
},
"hisSize": 937,
"wtSensorRef": {"_kind": "ref",
"val": "p:linkEdge:r:exampleSensorId",
"dis": "Sample Sensor Name"
},
"precision": 1,
"id": {"_kind": "ref",
"val": "p:linkEdge:r:exampleDataPointId",
"dis": "Sample Data Point Name"
}
}
}
]
}
]
]

Retrieve BI Data for Visualization

This endpoint retrieves BI data for a specified site and date. The data is returned in CSV format, which is structured for direct use in visualization tools, making it ideal for dashboards, reports, or other data analysis systems.

Authorization

To access this endpoint, you must include an AuthorizationToken header in your request. The AuthorizationToken is a 25-character alphanumeric code provided by the Innon team. Ensure that this token is kept secure and is included in every request.

Key Features:

CSV Response: Returns BI data in CSV format, ready for visualization tools.
Site-Specific Data: The siteId parameter allows retrieval of data for a specific site.
Date-Specific Data: Retrieve data for a specific date by providing the date query parameter.

Use this endpoint to integrate BI data into your visualization systems for dashboards, monitoring, or reporting purposes.

Authorizations:

None

query Parameters

date required	string <date> Example: date=2024-09-01 The date for which you want to retrieve the BI data. The format should be `YYYY-MM-DD`. This is a required parameter.
siteId required	string Example: siteId=example-site-id-1234 Unique identifier for the site from which you want to retrieve the data. This is a required parameter.

header Parameters

AuthorizationToken

required

string

Example: abc123def456ghi789jkl012mn

A 25-character alphanumeric token provided by the Innon team. This token is required to authenticate your requests.

Responses

Response samples

200
400
401
404

Content type

text/csv

dateTime,measurementVal,measurementUnit,idSensor,sensorName,equipRef
2024-08-23T23:45:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T00:00:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T00:15:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T00:30:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T00:45:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T01:00:00+01:00,17.600000381469727,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T01:15:00+01:00,17.5,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1
2024-08-24T01:30:00+01:00,17.5,°C,p:linkEdge:r:exampleSensorId1,Example Sensor 1,p:linkEdge:r:exampleEquipRef1

Data-Statistics

Retrieve Data Statistics

This endpoint retrieves statistics about the quantity and quality of data recorded starting from a specified date. The statistics include the total data size, average data size per day, and a breakdown of daily data sizes in bytes.

Authorization

To access this endpoint, you must include an AuthorizationToken in the header and provide a valid start_date as a query parameter. The system will then analyze all data recorded from the specified start date to the current date to generate statistics.

Key Features:

Data Quantity & Quality: Provides insights into the size of the data recorded daily and overall.
Estimated Data Size: Predicts future daily data sizes based on past averages.

Authorizations:

None

query Parameters

start_date

required

string <date>

Example: start_date=2024-08-24

The starting date from which the system should begin calculating data statistics. The format should be YYYY-MM-DD.

header Parameters

AuthorizationToken

required

string

Example: abc123def456ghi789jkl012mn

A valid token provided by the system to authenticate the user. This token is required to access the endpoint.

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"start_date": "2024-08-24",
"end_date": "2024-09-16",
"total_days": 24,
"total_data_size_bytes": 5547949,
"average_data_size_per_day_bytes": 231164.54166666666,
"estimated_future_daily_data_size_bytes": 231164.54166666666,
"daily_data_sizes_bytes": {"2024-08-24": 267329,
"2024-08-25": 275967,
"2024-08-26": 277010,
"2024-08-27": 269110,
"2024-08-28": 273158,
"2024-08-29": 275130,
"2024-08-30": 275224,
"2024-08-31": 277095,
"2024-09-01": 274473,
"2024-09-02": 274865,
"2024-09-03": 277238,
"2024-09-04": 278658,
"2024-09-05": 275845,
"2024-09-06": 277940,
"2024-09-07": 275892,
"2024-09-08": 275933,
"2024-09-09": 277896,
"2024-09-10": 276870,
"2024-09-11": 275899,
"2024-09-12": 134521,
"2024-09-13": 47147,
"2024-09-14": 47168,
"2024-09-15": 47058,
"2024-09-16": 40523
}
}