Page Comparison

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 Our product can integrate with a variety of business intelligence (commonly called BI) tools. By configuring new Module Plugins with the category “Business Intelligence”, MediaHaven will produce a list of reports by combining all reports across all plugins of this category.

Methods

A connector of the category “Business Intelligence” must implement the following methods depending on the category.

...

GET /reports

...

Return Returns a list of embeddable report URLs, they MUST be embeddable. Meaning . This means those URLs can be safely embed embedded into a 3rd party website (=MediaHaven FrontEnd in this case)

• Example and reference, please see metabase’s static embedding, which utilize JWT signing to defend against 3rd party website tamper with the embedded URL’s path parameter

Optional parameters

...

, specifically the MediaHaven frontend. If the BI tool wants to protect itself against tampering of the URL by the end-user (e.g. changing a parameter), then the connector should produce a signed URL which is inherently tamper-proof.

Optional parameters

Depending on the application and the authorizations of the user

filter.* parameters are parameters that should be handled by the reports as fixed filter parameters.

...

Expected headers

x-api-key: <reporting engine api key>

Output

[
  {
    "EmbedUrl": "https://mh-dev.mediahaven.com/reporting/embed/dashboard/

ABC#bordered=true&titled=true

",
    "Id": 123,
    "Label": "My report A",
    "Collection": "Collection",
    "Params": [
      {
        "Id": 123,
        "Label": "label",
        "Type": "Type"
      }
    ]
  },
  {
    "EmbedUrl": "https://mh-dev.mediahaven.com/reporting/embed/dashboard/

XYZ#bordered=true&titled=true

",
    "Id": 124,
    "Label": "My report B",
    "Collection": "Collection",
    "Params": [
      {
        "Id": 124,
        "Label": "label",
        "Type": "Type"
      }
    ]
  }
]

GET /reports/:id

Returns a specific report with the ID

Expected headers

x-api-key: <reporting engine api key>

Output

...

{
  "EmbedUrl": "https://mh-dev.mediahaven.com/reporting/embed/dashboard/

ABC#bordered=true&titled=true",
  "Id": 123,
  "Label": "My report A",
  "Collection": "Collection",
  "Params"

: [
    {
      "Id"

: 123,
      "Label"

: "label",
      "Type"

: "Type"
    }
  ]

}

GET /reports/:id