website logo
⌘K
Quickstart
User
Metrics
Webhooks
Mobile SDK
V2
React Native
Flutter
Android (Kotlin)
Swift
V1
Errors
FAQ
Docs powered by
Archbee
Metrics
API Version 2 (V2)

Podcasts

You can retrieve the favorite podcasts and episodes of the user data by user_id.


Get a podcasts data by user_id
GET
Params
Query Parameters
user_id
required
String
User ID returned by add integration request. This key should be stored in your database against the user and used for all interactions with the Spike API.
Header Parameters
authorizationtoken
optional
String
Client access token (deprecated)
x-spike-auth
required
String
Client access token
Python
Node.js
Ruby
Java
Curl
|
curl -X GET \
  'https://api.spikeapi.com/v2/metrics/podcasts/?user_id=282812818' \
  -H 'x-spike-auth: fa0b3803-1111-2222-9788-eccce210d30c'
RESPONSES
200
|
{
    "user_id": "282812818",
    "type": "podcasts",
    "source": [
        {
            "name": "spotify",
            "status": "ok"
        }
    ],
    "favorite_podcasts": [
		{
			"name": "The Free Audiobooks",
			"publisher": "The Free Audiobooks",
			"description": "'The Free Audiobooks' brings you a whole new collection of informative, useful, entertaining, and knowledgeable Audiobooks.",
		    "added_at": "2022-01-24T15:09:09",
		    "available_markets": [],
			"copyrights": [],
			"explicit": false,
			"external_urls": "https://open.spotify.com/show/6R76Hw6GPIX8AnFXE9UtWf"
			"languages": [ "en" ],
			"media_type": "audio",
			"total_episodes": 76,
		}
	],
	"saved_episodes": [
		{
			"name": "Swimming with Sharks in Caye Caulker Belize",
			"description": "Welcome to episode 1 of series 2 of Many Roads Travelled: (Solo Female) Travel Podcast The travel podcast that takes you on epic road trips around the world via public transport or hitching! So if you love to travel & travel adventures then come along for the ride! This first series was about my 16 months, 31k mile road trip from Paris to Cape Town way back in 1993/94! The 2nd series I about my solo month-long overland trip around Central America in February 2020.",
			"added_at": "2022-01-29T09:35:33",
			"fully_played": false,
			"resume_position_ms": 0
			"audio_preview_url": "https://p.scdn.co/mp3-preview/17ba151a8ca1df0c37508445407e43e28754f504",
			"duration_ms": 1729280,
			"explicit": false,
			"external_urls": "https://open.spotify.com/episode/7sV1Mg4VLDWJlqTrNfC8fi"
			"languages": [ "en-US" ],
			"release_date": "2021-12-10",
			"release_date_precision": "day",
			"podcast": {
			  "name": "Many Roads Travelled : (Solo Female) Travel Podcast",
			  "publisher": "Many Roads Travelled",
			  "description": "The travel podcast that takes you on epic adventures around the world!My first series will take you with me on my 16 months, 30,000+ mile road trip from Paris to Cape Town & back to Nairobi!
			  "available_markets": [ "US" ],
			  "copyrights": [],
			  "explicit": false,
			  "external_urls": "https://open.spotify.com/show/31ZuU6LHZofkvAa751fgNB" ,
			  "languages": [ "en" ],
			  "media_type": "audio",
			  "total_episodes": 65
			}
		}	
	],
	"topics": ["Technology", "Fashion", "Architecture"]
	}]
}

<style>
@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300&display=swap');

.h2, .h3, .list, .description{
	font-family: 'Poppins', sans-serif;
	font-weight: 500;
}

.h2 {
    margin-top: -20px;
    margin-bottom: 20px;

    font-size: 30px;
}

.h3 {
    font-size: 22px;
	margin-top: -20px;
}

.list-wrapper {
    white-space: normal;
     margin-top: -10px;
}

.list, .description {
    font-size: 14px;
}

</style>
<h2 class="h2">Fields</h2>
<h3 class="h3">Favorite_podcasts.name</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: The Free Audiobooks</li>
</ul><p class="description">The name of the podcast.</p>

<h3 class="h3">Favorite_podcasts.publisher</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: The Free Audiobooks</li>
</ul><p class="description">The publisher of the podcast.</p>

<h3 class="h3">Favorite_podcasts.description</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
</ul><p class="description">A description of the podcast.</p>

<h3 class="h3">Favorite_podcasts.added_at</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2022-01-24T15:09:09</li>
</ul><p class="description">Date and time when user added podcast to list</p>

<h3 class="h3">Favorite_podcasts.available_markets</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example: [ "DE", "US" ]</li>
</ul><p class="description">A list of the countries in which the podcast can be played, identified by their ISO 3166-1 alpha-2 code.</p>

<h3 class="h3">Favorite_podcasts.copyrights</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
</ul><p class="description">The copyright statements of the podcast.</p>

<h3 class="h3">Favorite_podcasts.explicit</h3>
<ul class="list-wrapper">
    <li class="list">Type: Boolean</li>
    <li class="list">Values: true | false</li>
</ul><p class="description">Whether or not the podcast has explicit content (true = yes it does; false = no it does not OR unknown).</p>

<h3 class="h3">Favorite_podcasts.external_urls</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: https://open.spotify.com/show/6R76Hw6GPIX8AnFXE9UtWf</li>
</ul><p class="description">External URLs for this podcast.</p>

<h3 class="h3">Favorite_podcasts.languages</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example: [ "en" ]</li>
</ul><p class="description">A list of the languages used in the podcast, identified by their ISO 639 code.</p>

<h3 class="h3">Favorite_podcasts.media_type</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: audio</li>
</ul><p class="description">The media type of the podcast.</p>

<h3 class="h3">Favorite_podcasts.total_episodes</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 20</li>
</ul><p class="description">The total number of episodes available</p>

<h3 class="h3">Saved_episodes.name</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: Swimming with Sharks in Caye Caulker Belize</li>
</ul><p class="description">The name of the episode</p>

<h3 class="h3">Saved_episodes.description</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
</ul><p class="description">A description of the episode.</p>

<h3 class="h3">Saved_episodes.added_at</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2022-01-24T15:09:09</li>
</ul><p class="description">Date and time when user added episode to list</p>

<h3 class="h3">Saved_episodes.fully_played</h3>
<ul class="list-wrapper">
    <li class="list">Type: Boolean</li>
    <li class="list">Values: true | false </li>
</ul><p class="description">Whether or not the episode has been fully played by the user.</p>

<h3 class="h3">Saved_episodes.resume_position_ms</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 22000</li>
</ul><p class="description">The user's most recent position in the episode in milliseconds.</p>

<h3 class="h3">Saved_episodes.audio_preview_url</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: https://p.scdn.co/mp3-preview/17ba151a8ca1df0c37508445407e43e28754f504</li>
</ul><p class="description">A URL to a short preview of the episode. null if not available.</p>

<h3 class="h3">Saved_episodes.duration_ms</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 1686233</li>
</ul><p class="description">The episode length in milliseconds.</p>

<h3 class="h3">Saved_episodes.explicit</h3>
<ul class="list-wrapper">
    <li class="list">Type: Boolean</li>
    <li class="list">Values: true | false</li>
</ul><p class="description">Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).</p>

<h3 class="h3">Saved_episodes.external_urls</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: https://open.spotify.com/episode/7sV1Mg4VLDWJlqTrNfC8fi</li>
</ul><p class="description">External URLs for this episode.</p>

<h3 class="h3">Saved_episodes.languages</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example: [ "en" ]</li>
</ul><p class="description">A list of the languages used in the episode, identified by their ISO 639 code.</p>

<h3 class="h3">Saved_episodes.release_date</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date, YYYY-MM-DD</li>
    <li class="list">Example: 2020-05-01</li>
</ul><p class="description">The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".</p>

<h3 class="h3">Saved_episodes.release_date_precision</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date, YYYY-MM-DD</li>
    <li class="list">Values: year | month | day </li>
</ul><p class="description">The precision with which release_date value is known</p>

<h3 class="h3">Saved_episodes.podcast.name</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: Many Roads Travelled : (Solo Female) Travel Podcast</li>
</ul><p class="description">The name of the podcast.</p>

<h3 class="h3">Saved_episodes.podcast.publisher</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: Many Roads Travelled</li>
</ul><p class="description">The publisher of the podcast.</p>

<h3 class="h3">Saved_episodes.podcast.description</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
</ul><p class="description">A description of the podcast.</p>

<h3 class="h3">Saved_episodes.podcast.available_markets</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example: [ "DE", "US" ]</li>
</ul><p class="description">A list of the countries in which the podcast can be played, identified by their ISO 3166-1 alpha-2 code.</p>

<h3 class="h3">Saved_episodes.podcast.copyrights</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
</ul><p class="description">The copyright statements of the podcast.</p>

<h3 class="h3">Saved_episodes.podcast.explicit</h3>
<ul class="list-wrapper">
    <li class="list">Type: Boolean</li>
    <li class="list">Values: true | false</li>
</ul><p class="description">Whether or not the podcast has explicit content (true = yes it does; false = no it does not OR unknown).</p>

<h3 class="h3">Saved_episodes.podcast.external_urls</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: https://open.spotify.com/show/6R76Hw6GPIX8AnFXE9UtWf</li>
</ul><p class="description">External URLs for this podcast.</p>

<h3 class="h3">Saved_episodes.podcast.languages</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example: [ "en" ]</li>
</ul><p class="description">A list of the languages used in the podcast, identified by their ISO 639 code.</p>

<h3 class="h3">Saved_episodes.podcast.media_type</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: audio</li>
</ul><p class="description">The media type of the podcast.</p>

<h3 class="h3">Saved_episodes.podcast.total_episodes</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 20</li>
</ul><p class="description">The total number of episodes available</p>

<h3 class="h3">Topics</h3>
<ul class="list-wrapper">
    <li class="list">Type: Array of strings</li>
    <li class="list">Example:  ["Technology", "Fashion", "Architecture"]</li>
</ul><p class="description">Key Topics Of Interest (TOI) of the particular user based on the type of Podcasts the user has engaged with historically. Key topics have been extracted using the Natural Language Processing (NLP) models proprietary to DataMe LLP. Textual fields used to derive topics from were the following: Show title, Show Description, Episode Title and Episode Description.</p>




Did this page help you?
PREVIOUS
Audio
NEXT
API Version 1 (V1)
Docs powered by
Archbee
Get Podcasts data
TABLE OF CONTENTS
GET
Get Podcasts data
Docs powered by
Archbee