Skip to content

  Totals

Aggregate metrics

Provides a high-level total without grouping by any dimension.

Always returns only a single row of metric data.

Allows including the previous_period=1 parameter to include data from the previous period, for example:

"users": 126370,
"users_previous_period": 126158,
"users_change": "0.17%",

Note

The previous period uses the same duration as the requested reporting period. When reporting on a month this may produce counter-intuitive results as it does not take into account variances between number of days in each month.

Get totals for stream '123' and '456' over the past 30 days with full results and compare to previous period
"<base>/stream/totals/metrics?range=last_30_days\
&result_type=full&previous_period=1&stream_id=123,456"

"results": [
    {
        "report_hours": 720,
        "users": 126370,
        "active_sessions": 252793,
        "session_starts": 249096,
        "total_listen_bytes": 11645750897308,
        "bounce_rate": "0%",
        "average_time_spent_listening": 71.48,
        "average_active_sessions": 12548.67,
        "sessions_per_user": 2,
        "minutes_per_user": 142.99,
        "total_listen_minutes": 18070087.93,
        "total_listen_hours": 301168.13,
        "users_previous_period": 126158,
        "users_change": "0.17%",
        "active_sessions_previous_period": 254060,
        "active_sessions_change": "-0.5%",
        "session_starts_previous_period": 248173,
        "session_starts_change": "0.37%",
        "total_listen_hours_previous_period": 302889.45,
        "total_listen_hours_change": "-0.57%"
    }
]

Top providers (customers)

Group results by provider(s).

Get top providers for January 2025
"<base>/stream/totals/top_providers?range=202501"

"results": [
    {
        "provider_name": "Radio Bob",
        "provider_id": "8",
        "users": 100
    },
    ...
]

Top channels (shows)

Group results by podcast channel(s).

Supported on podcast

Get top shows for provider 'abc' for the previous month
"<base>/podcast/totals/top_channels?range=previous_month&provider_id=abc"

"results": [
    {
        "provider_name": "BBC",
        "provider_id": "8",
        "channel_name": "BBC Minute",
        "channel_id": "123",
        "users": 50
    },
    ...
]

Top episodes

Group results by podcast episode(s).

Supported on podcast

Get top episodes for podcast shows 'daily_news' and 'morning_news' for this month
"<base>/podcast/totals/top_episodes?range=this_month&channel_id=daily_news,morning_news"

"results": [
    {
        "provider_name": "BBC",
        "provider_id": "8",
        "channel_name": "BBC Minute",
        "channel_id": "123",
        "episode_name": "BBC Minute 18 May 2020",
        "episode_id": "43255",
        "users": 25
    },
    ...
]

Published episodes

Group results by podcast episode(s), but also include only episodes whose publish date is within the reporting period.

Supported on podcast

Get top episodes for podcast show '123' published this month
"<base>/podcast/totals/published?range=this_month&channel_id=123"

"results": [
    {
        "provider_name": "BBC",
        "provider_id": "8",
        "channel_name": "BBC Minute",
        "channel_id": "123",
        "episode_name": "BBC Minute 18 May 2020",
        "episode_id": "43255",
        "dt_publish": "2021-04-30 14:46:57",
        "users": 512
    },
    ...
]

Top streams (stations)

Groups results by stream(s).

Supported on stream

Get top streams in February 2025 for provider 'radio_group'
"<base>/stream/totals/top_streams?range=202502&provider_id=radio_group"

"results": [
    {
        "provider_name": "BBC",
        "provider_id": "8",
        "stream_name": "MY FM",
        "stream_id": "21",
        "users": 512
    },
    ...
]

Peak stream listeners

Returns peak usage information for a stream.

Uses custom results specific to this query:

  • Peak number of concurrent users per hour,
  • Peak number of active sessions per hour,
  • The 95th percentile for each value, to discard to 5% of usage peaks.

Only returns one row of results.

Supported on stream

Get peak hourly users for stream '1' over the past 30 days
"<base>/stream/totals/peaks?range=last_30_days&stream_id=1"

"results": [
    {
        "users_p100": 31846,
        "users_p95": 30011,
        "as_p100": 40600,
        "as_p95": 38115
    },
]