Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stats > Radio Products → Get Total Players

AI-generated

Summary

Retrieves the total number of players for a specified radio product over a given time range.

Inputs

  • authentication — Authentication method to use for the Infomaniak API (OAuth2 or API Key).
  • path_radio_product_id (required) — Unique identifier of the radio product to query.
  • query_from (required) — Start date for the player statistics (inclusive).
  • query_to (required) — End date for the player statistics (inclusive).
  • queryParameters — Additional query parameters to include in the request; currently supports 'query_station_ids' for station identifiers.
  • returnFullResponse — If true, the full API response is returned; otherwise only the aggregated result is returned.

Output shape

aggregated player count (numeric) or full API response object when returnFullResponse is true

The operation returns a numeric total of players; when returnFullResponse is enabled, the complete API payload is returned, which may include additional metadata.

Examples

Example 1: Query total players for product ID 123 from 2023-01-01 to 2023-01-31 using OAuth2 and get only the aggregated count.

authentication: oauth2; path_radio_product_id: 123; query_from: 2023-01-01; query_to: 2023-01-31; returnFullResponse: false

Example 2: Use API Key for product ID 456 over June 2023 and request the full response.

authentication: apiKey; path_radio_product_id: 456; query_from: 2023-06-01; query_to: 2023-06-30; returnFullResponse: true

Example 3: Include station IDs 1,2,3 in the query for product ID 789 in July 2023.

authentication: oauth2; path_radio_product_id: 789; query_from: 2023-07-01; query_to: 2023-07-31; queryParameters: {"query_station_ids": "1,2,3"}

Links

Discussion