Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stats > Streams → Get Consumption

AI-generated

Summary

Fetch consumption statistics for a Infomaniak streaming radio product, station, and stream over a specified time range.

Inputs

  • authentication — Authentication method (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) — The start of the time range to request.
  • query_to (required) — The end of the time range to request.
  • returnFullResponse — Whether to include the full response payload.

Output shape

An object containing consumption metrics for the requested stream interval; when returnFullResponse is true the full response structure is returned, otherwise a concise summary is provided.

No pagination; optional fields depend on returnFullResponse setting. If neither start nor end dates are supplied the endpoint defaults to the predefined range but both parameters are marked required per definition.

Examples

Example 1: OAuth2 auth for product 123, station 45, stream 6 covering 2024-01-01 to 2024-01-02 with minimal response.

authentication=OAuth2; path_radio_product_id=123; path_station_id=45; path_stream_id=6; query_from=2024-01-01; query_to=2024-01-02; returnFullResponse=false

Example 2: API Key auth retrieving full response for product 10, station 20, stream 30 over a custom range.

authentication=API Key; path_radio_product_id=10; path_station_id=20; path_stream_id=30; query_from=2024-06-01; query_to=2024-06-30; returnFullResponse=true

Links

Discussion