Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

General → Get Media Top Clusters

AI-generated

Summary

Retrieve the top clusters data for a specified media item within a given channel from the Infomaniak VOD service.

Inputs

  • Authentication (required) — Choose the authentication method to use, either OAuth2 or API Key.
  • Channel (required) — Specify the channel identifier to target for retrieving top clusters.
  • Media (required) — Specify the media identifier within the channel to get top clusters for.
  • Return Full Response — Decide whether to return the full API response or just the data portion (defaults to false, returning only data).

Output shape

a JSON object containing the top clusters data related to the specified media item within the given channel, or optionally the full detailed API response if requested.

If 'Return Full Response' is set to false, the operation extracts and returns only the relevant data payload from the API response. If true, the full API response including metadata and headers is returned.

Examples

Example 1: Retrieve the top clusters for media '12345' in channel 'abcde' using OAuth2 authentication, returning only the data.

Set Authentication to OAuth2; Channel to 'abcde'; Media to '12345'; Return Full Response to false.

Example 2: Retrieve the full API response for analysis or debugging.

Set Return Full Response to true while providing required Channel and Media identifiers.

Links

Discussion