This feature is only available for CIM sites on the Premium tier. Contact us if you would like to upgrade your CIM site from Standard to Premium.
What does the CIM API do?
The CIM API lets you directly access the data captured and normalised by our platform including energy metrics, issues, sensor readings and more–all without the need for navigating the interface. It can be used to automate data transfers out of the platform.
For example, a data analyst can pull monthly utility meter and sub-meter usage across all buildings into a Google Looker Studio dashboard. An integrating developer can send equipment sensor data into an internal data warehouse.
What is an API?
An Application Programming Interface (API) is a way for applications to communicate with each other over the internet using a consistent format. The most common standard for this is the REST API, which allows clients (either individuals or applications) to retrieve and send information via the HTTP protocol from servers or databases. Popular examples of REST APIs include Stripe for payments, Google Maps for geolocation and Twilio for SMS.
Why is the CIM API useful?
The CIM API exists to make life easier for developers and data analysts. It enables them to pull the data they need for dashboards, visualisations, or integrations with other tools, without manual effort each time. It allows them to blend and customise data from different sources for reporting purposes. It reduces repetitive tasks and makes data more accessible and actionable.
Here is an example of a custom dashboard you can build using the CIM API. The API automates the export of water sub-meter usage data from PEAK into Google LookerStudio and blends it with additional dimensions like fund ownership.
Access the live dashboard here (Executive Water Usage KPI Dashboard). Refer to the CIM developer portal for an example use case script to implement this.
How does the CIM API work?
The CIM API is organised around REST and uses OAuth 2.0 for secure access. Once you have received your offline token you can begin testing live data requests via the interactive CIM developer portal.
While we do not build the actual connection between our API and our customer’s internal systems or dashboard tools, our detailed documentation provides scripts and guides to help your technical team get started. If questions arise, our support team is ready to help. Contact us at support@cim.io.
Our developer portal and example use cases can be found here:
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.
It’s available for customers and their consulting partners who have sites on the Premium tier.