Insights Connector API contract

Introduction

Our product can integrate with a variety of tools that offer additional insights into your object. By configuring new Module Plugins with the category “Insights”, MediaHaven will produce a list of reports by combining all reports across all plugins of this category.

Methods

A connector of the category “Insights” must implement the following 3 methods

1. https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4652335133/Insights+Connector+API+contract#POST-%2Fanalyze

Common

For all methods the following HTTP header is provided:

x-api-key: <API key for the downstream service>

POST /analyze

Analyzes the object such that insights can be requested for this object when the analysis is completed. The method is asynchronous, meaning it does not need to wait until the analysis is completed.

Input

The input is a JSON body with the following properties

Response / Output

• The HTTP response 204 No Content when the analysis was successfully started

Input Example

{
  "Config": {
    "CustomPropertyA" : "example"
  },
  "Metadata": {
    "Descriptive": {
        "Title": "My object",
        ...
    }
  }
}

GET insights/

Returns the list of available insights on the object without returning the detail of each insight.

Input

The input is a JSON object with the following properties

Response / Output

The output is a JSON array of JSON objects with the following properties

Example

{
  "Config": {
    "CustomPropertyA" : "example"
  },
  "RecordId": "11fba5aead9c4ea28b139a968f06bb2e33826b3eb5d24f57b6e13f0380617e66
  "
}

[
   {
      "Name": "Summary",
      "Id": "SUMMARIES"
   },
   {
      "Name": "Word cloud",
      "Id": "WORD_CLOUD"
   }
]