Joule
Search
K
Comment on page

API Documentation

Joule provide four core APIs that enable developers to extend the platform with custom domain artefacts

Available APIs

Joule has five core APIs which are intended for different uses.The table below outlines their descriptions and example use cases.
API
Description
Use case
Connector
Enables users programmatically develop custom data connectors
When there is a need to consume/publish events from a non-supported connector
Processor
Enables users programmatically develop custom event processors which exploit Joules existing features
Advanced analytic use cases where additional data processing is required
Analytics
A set of APIs that enables developers to define metrics, complex SQL queries, and ability to developer custom advanced analytics
Support advanced analytics, machine learning, dynamic logic processing etc,.
Metrics
Enables users to embed computed metrics within custom processors
Support advanced analytics, machine learning, dynamic logic processing etc,.
SQL
Enables users to leverage the power of ANSI SQL within custom processors
Execute complex queries that may span across metrics, reference data and additional data
Plugins
Developing feature engineering, data quality etc,. functions
Rest
Access processed data
Auditing