Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stats > Stations → Get Total Players

AI-generated

Summary

Retrieve total player count for a specified radio product and station within a given time range.

Inputs

  • authentication (required) — Authentication method: OAuth2 or API Key.
  • path_radio_product_id (required) — Unique identifier of the radio product.
  • path_station_id (required) — Unique identifier of the station.
  • query_from (required) — Start of the time range for the query (e.g., ISO date).
  • query_to (required) — End of the time range for the query (e.g., ISO date).
  • queryParameters — Additional query parameters such as stream IDs and HLS stats toggle.
  • returnFullResponse — If true, the full response body is returned; otherwise only the concise result.

Output shape

A JSON object containing the total player count and optional metadata.

The response includes a field 'total_players'; when returnFullResponse is true the full response is returned, which may include additional fields and pagination information.

Examples

Example 1: Get total players for radio product 123, station 45 between 2024-01-01 and 2024-01-31.

authentication: oauth2; path_radio_product_id: 123; path_station_id: 45; query_from: 2024-01-01; query_to: 2024-01-31; returnFullResponse: false

Links

Discussion