Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Alert → List Alerts.

AI-generated

Summary

List alerts for a specified channel in the Infomaniak VOD service, optionally handling pagination and filtering the response format.

Inputs

  • Authentication — Choose either OAuth2 or API Key authentication method.
  • Channel (required) — The unique identifier of the channel to list alerts for.
  • Additional Query Parameters — Optional parameters to control pagination and response content, including 'Return' to get total count only, 'Page' number, and 'Per Page' items count.
  • Return All — Whether to return all alerts (true) or limit the response according to 'Limit'.
  • Limit — Maximum number of alerts to return when 'Return All' is false; must be between 1 and 500.
  • Return Full Response — If true, returns the full API response including metadata, not just the alerts list.

Output shape

a list of alert objects or a full response object depending on 'Return Full Response' setting; if 'Return' is set to 'total', the output is a count of alerts matching the query; supports pagination and optionally returning all items.

If 'Return All' is true, the operation automatically handles pagination to retrieve all alerts; otherwise, results are limited by 'Limit'. When 'Return' query parameter is 'total', no alerts list is returned but the total count instead. The alerts correspond to the specified channel identifier.

Examples

Example 1: Retrieve all alerts for Channel 123 using OAuth2 authentication.

Set Authentication to OAuth2, Channel to 123, Return All to true.

Example 2: Retrieve first 50 alerts for Channel 456 with API Key authentication.

Set Authentication to API Key, Channel to 456, Return All to false, Limit to 50.

Example 3: Get only the total number of alerts for Channel 789.

Set Channel to 789, add query parameter Return=total.

Links

Discussion