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 Consumption
AI-generatedSummary
Retrieve consumption statistics for a specified radio product over a given time range.
Inputs
- authentication — Authentication method; either OAuth2 or API Key.
- path_radio_product_id (required) — The unique identifier of the radio product to request.
- query_from (required) — Start of the consumption period (inclusive).
- query_to (required) — End of the consumption period (inclusive).
- queryParameters — Additional query parameters; includes 'query_station_ids' to filter by station IDs.
- returnFullResponse — If true, returns the full API response; otherwise returns a trimmed summary.
Output shape
A JSON object containing consumption statistics for the specified period, optionally the full API response.
When returnFullResponse is true the complete API response is returned; otherwise a summarized object is returned. Results may be paginated if many items are present.
Examples
Example 1: Get consumption stats for product ID 12345 from Jan 1 to Jan 31, 2023 using an API key, requesting station IDs ST123 and returning the full response.
Authentication: apiKey; path_radio_product_id: 12345; query_from: 2023-01-01; query_to: 2023-01-31; queryParameters: { query_station_ids: 'ST123' }; returnFullResponse: true