Bühler Insights Platform API Documentation

Welcome to the documentation home for the Bühler Insights Platform API.

This public REST API provides easy access to the powerful capabilities of the Bühler Insights Platform. Our current features include data ingestion in the Generic Data Model (GDM) format and telemetry data query, enabling developers to integrate their applications seamlessly with the platform.

The Bühler Insights Platform API is a RESTful web service that facilitates communication between your application and the Bühler Insights Platform. By utilizing this API, you can easily ingest GDM data into the platform and query the data as needed.

Telemetry API

This endpoint allows you to query telemetry data, events, and alarms from Bühler Insights.

You can write queries in the Kusto Query Language (KQL) along with filters such as specific start and end times, and plant filters.

The Query API is identical to the Formula API used in dashboards and operates on an abstraction of the underlying Azure Data Explorer table. Results are provided in a data table format, designed for convenient consumption and processing by various languages and frameworks, such as Pandas (Python) and DataTable (C#).

Ingestion API

This endpoint allows you to ingest GDM messages containing arbitrary data points.

To ingest a message, you need a virtual device and a user with ingestion rights for this device. This is controlled via a contract on a digital service). To obtain such a contract, the plant or user must be activated on an external application contract, which can be requested through Bühler Insights Support.

You can generate GDM messages using the provided GDM SDK (.NET and Python) or the Swagger/OpenAPI specification.

Message ingestion is an asynchronous process, and it may take several minutes for a message to become visible via the query API. This delay depends on the API load and is beyond the control of the API user.

Support

If you need assistance or have any questions regarding the Bühler Insights Platform API, please feel free to reach out to our support team: Send an email to Support.

{"environments":[],"pdf-download":true}