Podcast Chart Presence

GET https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence

Current and historical charts for a podcast, with 14 UTC weekly best-rank cells and capture-based coverage.

Example request

curl -X GET "https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN"

const options = {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  }
};

fetch("https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.get("https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence", headers=headers)
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.GetAsync("https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.podengine.ai/api/v1/podcasts/:podcastIdOrSlug/charts/presence", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.podcasts.getPodcastChartPresence({
  podcastIdOrSlug: 'this-american-life',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.podcasts.get_podcast_chart_presence(
    podcast_id_or_slug="this-american-life",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "presence": {
      "window": {
        "startDate": "string",
        "endDate": "string",
        "weeks": [
          {
            "startDate": "string",
            "endDate": "string",
            "isPartial": true
          }
        ]
      },
      "latestChartDate": "string",
      "homeCountry": "string",
      "summary": {
        "onNow": 0,
        "markets": 0,
        "onNowByPlatform": {
          "apple": 0,
          "spotify": 0
        },
        "droppedOff30d": 0,
        "older": 0,
        "top10Now": 0
      },
      "charts": [
        {
          "chartType": "apple",
          "country": "string",
          "category": "string",
          "state": "on_now",
          "latestCaptureDate": "string",
          "lastSeen": {
            "date": "string",
            "position": 1
          },
          "previous": {
            "date": "string",
            "position": 1
          },
          "changeKind": "moved",
          "change": 0,
          "weeks": [
            {
              "best": 1,
              "status": "observed"
            }
          ],
          "weeksOn": 0,
          "weeksCaptured": 0,
          "capturesInWindow": 0,
          "daysOnChartInWindow": 0,
          "bestInWindow": 0,
          "averageInWindow": 0,
          "bestAllTime": {
            "date": "string",
            "position": 1
          },
          "firstSeenDate": "string"
        }
      ]
    }
  }
}

Request

Path parameters

podcastIdOrSlugstringrequired

Pod Engine ID or slug, Apple Podcasts ID, Spotify show ID, or podcast:guid

Query parameters

endDatestringregex

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

Response

200 application/json

statusliteral: OKrequired

dataobjectrequired1 field

presenceobjectrequired5 fields

windowobjectrequired3 fields

startDatestringrequiredregex

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

endDatestringrequiredregex

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

weeksarray of objectrequired3 fields

startDatestringrequiredregex

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

endDatestringrequiredregex

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

isPartialbooleanrequired

latestChartDatestringrequirednullableregex

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

homeCountrystringrequirednullable

summaryobjectrequired6 fields

onNownumberrequired

marketsnumberrequired

onNowByPlatformobjectrequired2 fields

applenumberrequired

spotifynumberrequired

droppedOff30dnumberrequired

oldernumberrequired

top10Nownumberrequired

chartsarray of objectrequired18 fields

chartTypeenumrequired

The type of chart, one of apple, spotify

applespotify

countrystringrequired

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

categorystringrequired

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"

stateenumrequired

on_nowdropped_30dolderunknown

latestCaptureDatestringrequiredregex

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

lastSeenobjectrequired2 fields

datestringrequiredregex

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

positionnumberrequiredmin 0

previousobjectrequirednullable2 fields

datestringrequiredregex

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

positionnumberrequiredmin 0

changeKindenumrequired

movedunchangednewbackoffunknown

changenumberrequirednullable

weeksarray of objectrequired2 fields

bestnumberrequirednullablemin 0

statusenumrequired

observed: ranked that day. off_chart: a fully resolved chart exists and the show is not on it. no_chart: no chart was captured that day. unknown: a chart exists but its coverage cannot prove absence.

observedoff_chartno_chartunknown

weeksOnnumberrequiredmin 0

weeksCapturednumberrequiredmin 0

capturesInWindownumberrequiredmin 0

daysOnChartInWindownumberrequiredmin 0

bestInWindownumberrequirednullable

averageInWindownumberrequirednullable

bestAllTimeobjectrequired2 fields

datestringrequiredregex

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

positionnumberrequiredmin 0

firstSeenDatestringrequiredregex

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