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 > Streams → Get Total Players
AI-generatedSummary
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