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 > Stations → Get Players
AI-generatedSummary
Retrieve player statistics for a specified radio station and time range.
Inputs
- authentication — Authentication method; either OAuth2 or API Key.
- path_radio_product_id (required) — The unique identifier (ID) of the radio product to request.
- path_station_id (required) — The unique identifier (ID) of the station to request.
- query_from (required) — Start of the time range for the statistics (ISO 8601 format).
- query_to (required) — End of the time range for the statistics (ISO 8601 format).
- queryParameters — Additional query parameters to include in the request, such as stream IDs or HLS stats flag.
- returnFullResponse — If true, the full response body is returned; otherwise only a success indicator is returned.
Output shape
a JSON object containing player statistics for the requested station
Returns detailed player data; optional fields may be omitted; errors are propagated as usual.
Examples
Example 1: Get listener count for a station over the last 30 minutes using OAuth2
authentication=oauth2, path_radio_product_id=12, path_station_id=45, query_from=2024-09-01T00:00:00Z, query_to=2024-09-01T00:30:00Z, returnFullResponse=false
Example 2: Retrieve full player stats for a specific stream using API Key and return full response
authentication=apiKey, path_radio_product_id=7, path_station_id=23, query_from=2024-09-01T00:00:00Z, query_to=2024-09-01T01:00:00Z, queryParameters={"query_stream_ids":"123","query_with_hls_stats":true}, returnFullResponse=true