What does the CIM API do?
The CIM API lets you directly access the data captured and normalised by our platform including energy metrics, alerts and actions, sensor readings and more–all without the need for navigating the interface. It can be used to automate data transfers out of the platform.
Who should use the CIM API?
The CIM API is intended for developers and data analysts who have knowledge of programming languages who need to integrate our data with other tools or platforms.
API documentation
Each endpoint below exposes its API schema as a Swagger/OpenAPI JSON file. You can view the raw specification directly, or load it into the Swagger Editor for an interactive, browsable view.
Swagger JSON endpoints
Endpoint | Swagger JSON | What it covers |
Core | Primary platform data and operations, including sites, levels, zones, meters, indoor environment, history. | |
Tickets | Alert and action tickets, related activity, and metrics. | |
Notifications | Event notifications via webhook subscriptions. |
How to view the docs in Swagger Editor
Download the JSON file and import into https://editor.swagger.io/
Open the Swagger JSON in a new browser tab and save the JSON file (e.g.
https://api.cimenviro.com/swagger.json)Open the Swagger Editor: https://editor.swagger.io/
Select File → Import File and choose the .json file you saved in step 1
The editor will render the interactive documentation in the right-hand pane.