Historical Chart

GET /charts

Get a historical chart

TOKEN

Authentication

This endpoint requires an API token. You can learn more about how to get an API token from the authentication page.

URL

https://api.podengine.ai/api/v1/charts

Code Example

API Specification

Query Parameters

PropertyTypeDescription
chartTypeoptional
enum ⓘ

Allowed values

applespotify

The type of chart, one of apple, spotify

categoryoptional
string

The chart category defaulting to 'top podcasts'. Apple podcasts supports the following: "top podcasts", "arts", "business", "comedy", "education", "fiction", "government", "health & fitness", "history", "kids & family", "leisure", "music", "news", "religion & spirituality", "science", "society & culture", "sports", "technology", "true crime", "tv & film"

countryoptional
string

The country of the chart in ISO 3166-1 alpha-2 format, for example "us". Defaults to us.

positionsLimitoptional
number ⓘ

Constraints:

>= 1<= 200

The number of chart positions to return. If not provided, all positions are returned

dateoptionalnullable
string ⓘ

Constraints:

regex

The date of the chart in YYYY-MM-DD format. If null will return the latest chart

200

Success Response

PropertyTypeDescription
status
literal: OK

data
object

options
object

Get a specific podcast chart

chartTypeoptional
enum ⓘ

Allowed values

applespotify

The type of chart, one of apple, spotify

categoryoptional
string

The chart category defaulting to 'top podcasts'. Apple podcasts supports the following: "top podcasts", "arts", "business", "comedy", "education", "fiction", "government", "health & fitness", "history", "kids & family", "leisure", "music", "news", "religion & spirituality", "science", "society & culture", "sports", "technology", "true crime", "tv & film"

countryoptional
string

The country of the chart in ISO 3166-1 alpha-2 format, for example "us". Defaults to us.

positionsLimitoptional
number ⓘ

Constraints:

>= 1<= 200

The number of chart positions to return. If not provided, all positions are returned

dateoptionalnullable
string ⓘ

Constraints:

regex

The date of the chart in YYYY-MM-DD format. If null will return the latest chart

chartnullable
object

chart
object

chartType
enum ⓘ

Allowed values

applespotify

The type of chart, one of apple, spotify

category
string

The chart category defaulting to 'top podcasts'. Apple podcasts supports the following: "top podcasts", "arts", "business", "comedy", "education", "fiction", "government", "health & fitness", "history", "kids & family", "leisure", "music", "news", "religion & spirituality", "science", "society & culture", "sports", "technology", "true crime", "tv & film"

country
string

The country of the chart in ISO 3166-1 alpha-2 format, for example "us". Defaults to us.

chartDate
string ⓘ

Constraints:

regex

The date of the chart in YYYY-MM-DD format

positions
array
of
object

position
number

podcastOnChart
object

podcastOnChartId
string

title
string

imageUrlnullable
string ⓘ

Constraints:

url

podenginePodcastnullable
object

authornullable
string

authorityScorenullable
object

calculatedAt
date

authorityScore
number

This is the weighted total authority score of the podcast, out of 100

qualityScore
number

This is the quality score of the podcast, out of 100

youtubeScore
number

This is the YouTube score of the podcast, out of 100

socialScore
number

This is the social score of the podcast, out of 100

engagementScore
number

This is the engagement score of the podcast, out of 100

genres
array
of
string

id
string

imageUrlnullable
string

language
string

lastEpisodePublishedAt
date

slug
string

title
string

titleLatest
string