Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Stats > Channel > Viewers → Viewers Share

AI-generated

Summary

Fetches viewer share statistics for a specified channel over a defined time range.

Inputs

  • authentication — Authentication method to use for the Infomaniak API request (oauth2 or apiKey).
  • path_channel (required) — The unique identifier (ID) of the Pack order (channel) to query.
  • query_from (required) — Start date for the consumption time range (format: YYYY-MM-DD).
  • query_to (required) — End date for the consumption time range (format: YYYY-MM-DD).
  • query_per (required) — Granularity for the results, one of day, hour, minute, month, quarter, week, year.
  • query_account_id (required) — Identifier of the account associated with the channel.
  • returnFullResponse — If true, the full API response is returned; otherwise only the relevant portion is returned.

Output shape

array of objects representing viewer share metrics

Each object contains share statistics such as viewer count and time bucket; pagination may be indicated; optional fields may be omitted; errors follow standard HTTP error responses.

Examples

Example 1: Basic request using OAuth2 for channel 123 over Jan 2023 with weekly granularity.

authentication=oauth2; path_channel=123; query_from=2023-01-01; query_to=2023-01-31; query_per=week; query_account_id=456; returnFullResponse=false

Example 2: API Key authentication retrieving daily data for June 2023, returning full response.

authentication=apiKey; path_channel=101; query_from=2023-06-01; query_to=2023-06-30; query_per=day; query_account_id=789; returnFullResponse=true

Example 3: Minimal configuration using default account ID 0, fetching monthly data for a channel.

authentication=oauth2; path_channel=5; query_from=2024-01-01; query_to=2024-01-31; query_per=month; query_account_id=0; returnFullResponse=false

Links

Discussion