Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

General → Get Media Viewing Time

AI-generated

Summary

Retrieve the viewing time statistics for a specific media item within a specified channel from the Infomaniak VOD service.

Inputs

  • Authentication (required) — Choose the authentication method to use for the request, either OAuth2 or API Key.
  • Channel (required) — Specify the channel identifier in which the media item resides.
  • Media (required) — Specify the media identifier for which to retrieve viewing time data.
  • Additional Query Parameters — Optionally provide additional query parameters such as 'From' (the starting date timestamp) to filter the viewing time statistics.
  • Return Full Response — If true, returns the complete response object from the API instead of just the extracted data.

Output shape

a JSON object containing viewing time statistics for the specified media or the full API response if requested

The output shape depends on the 'Return Full Response' flag. If false, only the relevant data is returned. The operation requires specifying valid 'Channel' and 'Media' identifiers; additional filtering is possible via query parameters such as the 'From' timestamp.

Examples

Example 1: Retrieve viewing time data for media 'abc123' in channel 'channel789' starting from a specific timestamp.

Set Authentication to 'OAuth2' or 'API Key', provide 'channel789' for Channel, 'abc123' for Media, optionally set 'From' parameter to a timestamp, and leave 'Return Full Response' false to get parsed data.

Links

Discussion