Summarize a podcast's chart presence

Returns a one-call aggregate of the podcast’s current chart presence: the number of distinct chart slots, sources, countries, and categories it appears on, plus the single best (lowest-numbered) rank it currently holds and a per-source breakdown.

GET /v1/podcasts/{id}/rankings/summary

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/podcasts/{id}/rankings/summary"

200

{
  "appearances_by_source": [
    {
      "best_rank": 123,
      "chart_count": 123,
      "source": "apple",
      "best_category_slug": "<string>",
      "best_country": "<string>"
    }
  ],
  "category_count": 123,
  "chart_count": 123,
  "country_count": 123,
  "podcast": {
    "id": "<string>",
    "title": "<string>",
    "best_rank": {
      "captured_at": "2023-11-07T05:31:56Z",
      "chart_type": "top_podcasts",
      "rank": 123,
      "source": "apple",
      "category_slug": "<string>",
      "country": "<string>"
    },
    "image_url": "<string>",
    "popularity": 123,
    "publisher": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    },
    "slug": "<string>"
  },
  "source_count": 123,
  "best_rank": {
    "captured_at": "2023-11-07T05:31:56Z",
    "chart_type": "top_podcasts",
    "rank": 123,
    "source": "apple",
    "category_slug": "<string>",
    "country": "<string>"
  }
}

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

id · string · required

Podcast slug, internal ID, or numeric iTunes ID.

Response

200

application/json

OK

appearances_by_source · object[] | null · required

Per-source breakdown of chart presence and best rank.

Show child attributes

category_count · integer<int64> · required

Number of distinct categories currently charting this podcast.

chart_count · integer<int64> · required

Number of distinct chart slots (source × country × category) on which this podcast currently appears.

country_count · integer<int64> · required

Number of distinct countries currently charting this podcast.

podcast · object · required

The podcast this summary describes.

Show child attributes

source_count · integer<int64> · required

Number of distinct sources currently charting this podcast.

best_rank · object

The single best (lowest-numbered) rank this podcast currently holds across all charts. Null when the podcast holds no current chart appearances.

Show child attributes