This contract is currently in the Proof-of-concept stage and still subject to change
Introduction
To expose Reporting services to our system, we need an API to be exposed for the MediaHaven installation. When creating new Module Plugins having of the following Plugin Category:
Business Intelligence
then MediaHaven will connect to this plugin using REST API calls, which must implement the following methods depending on the category.
Methods
GET /info BUSINESS INTELLIGENCE
It gives basic info about this connector
Expected parameters
None
Expected headers
x-api-key: <reporting engine api key>
Output
{
"ReportingEngine": {
"Name": "metabase",
"Version": "0.51",
}
}
GET /reports BUSINESS INTELLIGENCE
Expected parameters
None
Expected headers
x-api-key: <reporting engine api key>
Output
{
"ReportingEngine": {
"Name": "metabase",
"Version": "0.51",
},
"Reports": {
"EmbedUri": "https://metabase/embedded/report/x/y/z"
"LastDataRefresh": "2024-10-24T15:26:59Z"
}
}