Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stats > Streams → Get Listeners

AI-generated

Summary

Fetch a list of listener statistics for a specified radio stream within a given time range.

Inputs

  • authentication (required) — Authentication method to use (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.
  • path_stream_id (required) — The unique identifier (ID) of the stream to request.
  • query_from (required) — Start time for the listener statistics query (ISO 8601 or timestamp).
  • query_to (required) — End time for the listener statistics query (ISO 8601 or timestamp).
  • returnFullResponse (required) — When true, the full HTTP response is returned; otherwise only the parsed data.

Output shape

an array of listener objects representing listener statistics

If returnFullResponse is true, the full HTTP response is returned; otherwise only the parsed data. Results may be paginated based on query parameters.

Examples

Example 1: Retrieve listener counts for a specific stream between dates

Authentication: OAuth2; Radio Product Id: 123; Station Id: 45; Stream Id: 6; From: '2023-01-01'; To: '2023-01-31'; Return Full Response: false

Example 2: Get full response for debugging

Authentication: API Key; Radio Product Id: 123; Station Id: 45; Stream Id: 6; From: '2023-02-01'; To: '2023-02-28'; Return Full Response: true

Example 3: Fetch aggregated stats with default dates

Authentication: OAuth2; Radio Product Id: 123; Station Id: 45; Stream Id: 0; From: ''; To: ''; Return Full Response: false

Links

Discussion