Other/api.clarify.io

Get bundle insight

v1.0.0

Gets a particular insight for a bundle. Typically, you will hit this endpoint from a link contained in a response to /v1/bundles/{bundle_id}/insights

The insight response may contain a data object containing insight-specific data and/or an array of objects called track_data, where the array indexes correspond to the tracks in the bundle. Each object in the array contains the track_id, track_label and insight-specific data related to that insight. For example, in the spoken_words insight, the track_data objects contain the field word_count which is the number of spoken words found in the track.

Documentation on the insights available and the data returned can be found at

Insights that contain data in different file formats (such as for video captions) will have one or more link relations in the _links array for the corresponding data. Note that the href URLs in these links have a limited lifespan and should not be stored locally.

Input

{
  "type": "object",
  "properties": {
    "bundle_id": {
      "type": "string"
    },
    "insight_id": {
      "type": "string"
    }
  },
  "required": [
    "bundle_id",
    "insight_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}