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 Consumption
AI-generatedSummary
Retrieve total consumption statistics for a specific radio stream.
Inputs
- authentication — Authentication method (OAuth2 or API Key).
- path_radio_product_id (required) — The ID of the radio product.
- path_station_id (required) — The ID of the station.
- path_stream_id (required) — The ID of the stream.
- query_from (required) — Start timestamp (ISO 8601) for the consumption period.
- query_to (required) — End timestamp (ISO 8601) for the consumption period.
- returnFullResponse — If true, returns the full API response; otherwise returns a summary.
Output shape
object containing consumption metrics (e.g., total_bytes, total_duration).
The exact fields depend on the radio product; missing fields indicate no consumption data for the interval.
Examples
Example 1: Fetch total bytes consumed between two dates for a given stream.
Authentication: OAuth2; Radio Product ID: 12345; Station ID: 9876; Stream ID: 54321; From: 2024-01-01T00:00:00Z; To: 2024-01-31T23:59:59Z; Return Full Response: false