INinfomaniak
Stats > Radio Products

Get consumption

This endpoint allows you to retrieve product consumption stats.

get/1/radios/{radio_product}/stats/consumption

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/radios/{radio_product}/stats/consumption
  • Auth
    HTTP bearer

Path parameters

radio_productinteger required

The unique identifier (ID) of the radio product to request.

Query parameters

fromstring required

Specify the starting date to get stats

Example:2022-01-01, 2022-01-01 00:00:00, 1640995200
scope_by'day' | 'month' | 'week' | 'year'

Specifies the time period over which to aggregate and retrieve stats

station_idsstring

List of station ids for get stats

Example:1,3,5
tostring required

Specify the ending date to get stats

Example:2022-12-31, 2022-12-31 00:00:00, 1672444800

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success",
  "data": [
    {
      "date": "1679754593",
      "bytes": 131315,
      "average_bytes_by_listeners": 15621
    }
  ]
}

Changes

No recorded changes to this operation across all 40 revisions of this API.