API: Statistics
In this page
- IAB Certified Statistics
- Overall Statistics
- Endpoints
- Response
- Retrieving a User’s Overall Statistics
- Example
- Retrieving a Show’s Overall Statistics
- Example
- Retrieving an Episode’s Overall Statistics
- Example
- Plays and Downloads Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Play Statistics
- Example
- Retrieving a Show’s Play Statistics
- Example
- Retrieving a User’s Shows’ Total Play Statistics
- Example
- Retrieving an Episode’s Play Statistics
- Example
- Retrieving a Show’s Episodes’ Total Play Statistics
- Example
- Likes Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Likes Statistics
- Example
- Retrieving a Show’s Likes Statistics
- Retrieving an Episode’s Likes Statistics
- Followers Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Followers Statistics
- Example
- Sources Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Sources Statistics
- Example
- Retrieving a Show’s Sources Statistics
- Example
- Retrieving an Episode’s Sources Statistics
- Example
- Devices Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Devices Statistics
- Example
- Retrieving a Show’s Devices Statistics
- Example
- Retrieving an Episode’s Devices Statistics
- Example
- Operating Systems Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Operating Systems Statistics
- Example
- Retrieving a Show’s Operating Systems Statistics
- Example
- Retrieving an Episode’s Operating Systems Statistics
- Example
- Geographic Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a User’s Geographic Statistics
- Example
- Retrieving a Show’s Geographic Statistics
- Listeners Statistics
- Endpoints
- CSV File
- Request Parameters
- Response
- Retrieving a Show’s Listeners Statistics
- Example
IAB Certified Statistics
Our statistics are officially certified by IAB Technology Lab (IAB). Adhering to the IAB podcast measurement guidelines helps us deliver clearer insight into the users who listen to your podcast episodes and has improved the way our statistics system detects fake plays and downloads originated by bots. The figures you see in your statistics now exclude users who have listened to less than one minute of an episode.
Overall Statistics
Endpoints
Response
The Statistics API always returns a list of objects with the following fields:
Property | Type | Description |
---|---|---|
plays_count |
Number | The number of all-time plays (both live and on demand). Available in users , shows , and episodes statistics. |
downloads_count |
Number | The number of all-time downloads. Available in users , shows , and episodes statistics. |
plays_ondemand_count |
Number | The number of all-time on demand plays. Available in users , shows , and episodes statistics. |
plays_live_count |
Number | The number of all-time live plays. Available in users , shows , and episodes statistics. |
likes_count |
Number | The number of all-time likes. Available in users , shows , and episodes statistics. |
episodes_count |
Number | The number of listenable episodes. Only available in users and shows statistics. |
shows_count |
Number | The number of shows created. Only available in users statistics. |
followers_count |
Number | The current number of followers. Only available in users statistics. |
chapters_count |
Number | The current number of chapters. Only available in episodes statistics. |
messages_count |
Number | The current number of messages. Only available in episodes statistics. |
user |
User | The user details. Available in users statistics. |
show |
Show | The show details. Available in shows statistics. |
episode |
Episode | The episode details. Available in episodes statistics. |
Retrieving a User’s Overall Statistics
Authenticated: yes
This API returns a JSON object containing a user’s all-time overall statistics.
Example
Retrieving a Show’s Overall Statistics
Authenticated: yes
This API returns a JSON object containing a show’s all-time overall statistics.
Example
Retrieving an Episode’s Overall Statistics
Authenticated: yes
This API returns a JSON object containing an episode’s all-time overall statistics.
Example
Plays and Downloads Statistics
Plays and Downloads Statistics API makes a distinction between number of plays and number of downloads: if you are interested in learning more, you can consult this article in our Spreaker Help Center.
Endpoints
CSV File
In order to get a CSV file with the Play Statistics, a .csv
needs to be added to the end of the endpoint and then use the same parameters as the regular request.
Request Parameters
These are the request parameters for any Play Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
group |
Yes | String | The group-type to apply to the statistics. It can be day , week , or month . |
Response
The Statistics API always returns a list of objects with the following fields:
Property | Type | Description |
---|---|---|
date |
A date string in the format YYYY-MM-DD |
The date the data is relative to, depending on the group-type:day - the specific day the data relates to.week - the first day (Sunday) of the week the data relates to.month - the first day of the month the data relates to. |
plays_count |
Number | Number of plays (both live and on demand). |
plays_live_count |
Number | Number of plays while broadcasting live. |
plays_ondemand_count |
Number | Number of on demand plays. |
downloads_count |
Number | Number of downloads. |
Retrieving a User’s Play Statistics
Authenticated: yes
This API returns a JSON object containing statistics relative to all of a user’s show and episode plays, according to a particular interval and grouped by the requested group-type.
Example
Retrieving a Show’s Play Statistics
Authenticated: yes
This API returns a JSON object containing a specific show’s play statistics, based on a certain interval and grouped by the requested group-type.
Example
Retrieving a User’s Shows’ Total Play Statistics
Authenticated: yes
This API returns a paginated list of items containing total play statistics for each show owned by the USER-ID
, based on a certain date interval.
Example
The response body is a paginated list of items.
Retrieving an Episode’s Play Statistics
Authenticated: yes
This API returns a JSON object containing a specific episode’s play statistics, based on a certain interval and grouped by the requested group-type.
Example
Retrieving a Show’s Episodes’ Total Play Statistics
Authenticated: yes
This API returns a paginated list of items containing total play statistics for each episode belonging to the SHOW-ID
, based on a certain date interval.
Example
The response body is a paginated list of items.
Likes Statistics
Endpoints
CSV File
In order to get a CSV file of the Likes Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Likes Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
group |
Yes | String | The group-type to apply to the statistics. It can be day , week or month . |
Response
The Statistics API always returns a list of objects with the following fields:
Property | Type | Description |
---|---|---|
date |
A date string in the format YYYY-MM-DD |
The date the data is relative to, depending on the group-type:day - the specific day the data relates to.week - the first day (Sunday) of the week the data relates to.month - the first day of the month the data relates to. |
likes_count |
Number | Number of likes obtained. |
Retrieving a User’s Likes Statistics
Authenticated: yes
This API returns a JSON object containing a user’s show and episode likes statistics, based on a certain interval and grouped by the requested group-type.
Example
Retrieving a Show’s Likes Statistics
Authenticated: yes
This API returns a JSON object containing a specific show’s likes statistics, based on a certain interval and grouped by the requested group-type.
Retrieving an Episode’s Likes Statistics
Authenticated: yes
This API returns a JSON object containing a specific episode’s likes statistics, based on a certain interval and grouped by the requested group-type.
Followers Statistics
Endpoints
CSV File
In order to get a CSV file of the Followers Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Followers Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
group |
Yes | String | The group-type to apply to the statistics. It can be day , week or month . |
Response
The Followers Statistics API always returns a list of objects with the following fields:
Property | Type | Description |
---|---|---|
date |
A date string in the format YYYY-MM-DD |
The date the data is relative to, depending on the group-type:day - the specific day the data relates to.week - the first day (Sunday) of the week the data relates to.month - the first day of the month the data relates to. |
followers_count |
Number | Number of followers. |
Retrieving a User’s Followers Statistics
Authenticated: yes
This API returns a JSON object containing a user’s followers statistics, based on a certain interval and grouped by the requested group-type.
Example
Sources Statistics
Endpoints
CSV File
In order to get a CSV file with the Sources Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for any Sources Statistics request.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
group |
Yes | String | The group-type to apply to the statistics. It can be day , week , or month . |
precision |
Yes | Number | Precision, in decimal places, of the percentage returned for each source (defaults to 0 ). |
Response
The Sources Statistics API always returns a JSON object with two proprieties, overall
and details
, each containing a list.
The overall
list contains objects with the following properties:
Property | Type | Description |
---|---|---|
name |
String | The name of the source. |
plays_count |
Number | Total number of plays and downloads from this source. |
percentage |
Number | Percentage of plays and downloads from this source. |
The details
list contains objects with the following properties:
Property | Type | Description |
---|---|---|
date |
A date string in the format YYYY-MM-DD |
The date the data is relative to, depending on the group-type:day - the specific day the data relates to.week - the first day (Sunday) of the week the data relates to.month - the first day of the month the data relates to. |
* |
Number | Percentage of plays and downloads from each source on that time period. The property is the name of the source and the value will be the percentage. i.e. “YouTube”: 10 means that 10% of plays/downloads came from YouTube in that time frame. |
Retrieving a User’s Sources Statistics
Authenticated: yes
This API returns a JSON object containing the statistics relative to the play and download sources, grouped by the requested group-type.
Example
Retrieving a Show’s Sources Statistics
Authenticated: yes
This API returns a JSON object containing the statistics relative to the play and download sources, grouped by the requested group-type.
Example
Retrieving an Episode’s Sources Statistics
Authenticated: yes
This API returns a JSON object containing the statistics relative to the plays and download sources, grouped by the requested group-type.
Example
Devices Statistics
Endpoints
CSV File
In order to get a CSV file with Devices Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Devices Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
precision |
Yes | Number | Precision, in decimal places, of the percentage returned for each device type (defaults to 0 ). |
Response
The Devices Statistics API always returns a list of device types and their respective percentages of plays and downloads.
Property | Type | Description |
---|---|---|
name |
String | The name of the type of device. Can be Desktop , Mobile , Tablet , Others . |
percentage |
Number | Percentage of plays and downloads from this device type. |
Retrieving a User’s Devices Statistics
Authenticated: yes
Example
Retrieving a Show’s Devices Statistics
Authenticated: yes
Example
Retrieving an Episode’s Devices Statistics
Authenticated: yes
Example
Operating Systems Statistics
Endpoints
CSV File
In order to get a CSV file with the Operating Systems Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Operating Systems Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
precision |
Yes | Number | Precision, in decimal places, of the percentage returned for each device type (defaults to 0 ). |
Response
The Operating Systems Statistics API always returns a JSON object with the proprieties desktop
and mobile
, each containing a list of its own following proprieties.
The mobile
list aggregates operating systems from both mobile and tablet devices.
Property | Type | Description |
---|---|---|
name |
String | The name of the operating system. |
percentage |
Number | Percentage of plays and downloads from this operating system. |
Retrieving a User’s Operating Systems Statistics
Authenticated: yes
Example
Retrieving a Show’s Operating Systems Statistics
Authenticated: yes
Example
Retrieving an Episode’s Operating Systems Statistics
Authenticated: yes
Example
Geographic Statistics
Endpoints
CSV File
In order to get a CSV file with the Geographic Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Geographic Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
precision |
Yes | Number | Precision, in decimal places, of the percentage returned for each country and city (defaults to 0 ). |
Response
The Geographic Statistics API always returns a JSON object with two proprieties, country
and city
, that each contain a list.
Each of the lists has objects with the following fields:
Property | Type | Description |
---|---|---|
name |
String | The name of the place, either country or city. |
percentage |
Number | The percentage of plays and downloads from this place. |
Retrieving a User’s Geographic Statistics
Authenticated: yes
This API returns a JSON object containing the statistics relative to the countries and cities from which a user’s shows and episodes were listened in from, based on a certain interval and with the requested precision.
Example
Retrieving a Show’s Geographic Statistics
Authenticated: yes
This API returns a JSON object containing the statistics relative to the countries and cities from which a specific show was listened in from, based on a certain interval and with the requested precision.
Listeners Statistics
Endpoints
CSV File
In order to get a CSV file of the Listeners Statistics, a .csv
needs to be added to the end of the endpoint and then used with the same parameters as the regular request.
Request Parameters
These are the request parameters for Listeners Statistics.
Parameter | Required | Type | Description |
---|---|---|---|
from |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics since, and including, this date. |
to |
Yes | A date string in the format YYYY-MM-DD |
Date filter to get statistics until, and including, this date. |
group |
Yes | String | The group-type to apply to the statistics. It can be day , week or month . |
Response
The Listeners Statistics API always return a list of objects with the following fields:
Property | Type | Description |
---|---|---|
date |
A date string in the format YYYY-MM-DD |
The date the data is relative to, depending on the group-type:day - the specific day the data relates to.week - the first day (Sunday) of the week the data relates to.month - the first day of the month the data relates to. |
listeners_count |
Number | Number of listeners. |
Retrieving a Show’s Listeners Statistics
Authenticated: yes
This API returns a JSON object containing statistics relative to all the listeners of a show, according to a particular interval and grouped by the requested group-type.