Actions141
- Auto DJ Actions
- Auto DJ > Events Actions
- Auto DJ > Media Actions
- Auto DJ > Playing Playlist Actions
- Auto DJ > Playlist Actions
- Encoder Events Actions
- Hls Stream Actions
- Mediapulse Actions
- Notifications Actions
- Options Actions
- Packs Actions
- Players Actions
- Radio Product Options Actions
- Radio Products Actions
- Server Events Actions
- Stations Actions
- Stats > Hls Stream Actions
- Stats > Radio Products Actions
- Stats > Stations Actions
- Get Status
- Get Instant Listeners
- Get Stats Listeners
- Get Mediastats
- Set Metadata To Station
- Get Listeners
- Get Listeners Per Minute
- Get Listeners Per Minute Per Stream
- Get Countries
- Get Countries By Continent
- Get Listeners By Stream
- Get Consumption
- Get Total Consumption
- Get Consumption By Stream
- Get Players
- Get Total Players
- Get Stats By Streams
- Export Stats
- Export Stats By Stream
- List Stats Links
- Stats > Streams Actions
- Streams Actions
- Transcodings Actions
Stats > Radio Products → Get Total Players
AI-generatedSummary
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"}