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

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 to return until the analysis is completed.

Input

The input is a JSON body with the following properties

Response / Output

• The HTTP response 202 Accepted when the analysis was successfully started

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 uses the following HTTP parameters

Response / Output

• 200 OK with the response

• 409 Conflict when the analysis is still pending

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

Example

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

GET insights/{ID}

Returns the details of a particular insight including the raw data.

Input

• The insight ID is specified as a path variable.

• The input uses the following HTTP parameters

Response / Output

• 200 OK with the response

• 409 Conflict when the analysis is still pending

• The output is a JSON object with the following properties

Example

{
  "Name": "Word cloud",
  "Id": "WORD_CLOUD",
  "Data": "<your data>"
}