Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stats > Streams → Get Total Players

AI-generated

Summary

Retrieve total player count for a specified radio product, station, and stream within a given date range.

Inputs

  • authentication (required) — Authentication method: either OAuth2 or an API Key.
  • path_radio_product_id (required) — Unique identifier of the radio product.
  • path_station_id (required) — Unique identifier of the station.
  • path_stream_id (required) — Unique identifier of the stream.
  • query_from (required) — Start date for the statistics query (inclusive).
  • query_to (required) — End date for the statistics query (inclusive).
  • returnFullResponse — If true, returns the full API response; otherwise returns a compact result.

Output shape

numeric count of total players

Returns a single number; may be 0 if no streams match. When returnFullResponse is true, the full JSON payload is returned.

Examples

Example 1: Fetch total players for product 123 from 2024-01-01 to 2024-01-31

authentication: OAuth2, path_radio_product_id: 123, path_station_id: 45, path_stream_id: 6, query_from: 2024-01-01, query_to: 2024-01-31, returnFullResponse: false

Example 2: List total players with full metadata

authentication: API Key, path_radio_product_id: 123, path_station_id: 45, path_stream_id: 6, query_from: 2024-01-01, query_to: 2024-01-31, returnFullResponse: true

Example 3: Default call with minimal parameters

authentication: OAuth2, path_radio_product_id: 0, path_station_id: 0, path_stream_id: 0, query_from: , query_to: , returnFullResponse: false

Links

Discussion