# podscan.fm OpenAPI overview

> Below is an overview of the podscan.fm openapi in simple language. This API contains 283 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/podscan.fm/[idOrRoute]

Podscan.fm v1.0.0 - https://podscan.fm

> **Note:** The previous version of the REST API documentation is still available at [podscan.fm/docs/api](https://podscan.fm/docs/api).

# Podscan REST API Documentation
The Podscan API is a RESTful API that allows you to access the Podscan platform. The API is designed to be easy to use and to have predictable, resource-oriented URLs. The API uses standard HTTP response codes and verbs, and authenticates using standard HTTP Basic Authentication.

You'll find a tutorial video on how to use the API here: [![https://www.youtube.com/watch?v=fSdDGp4R7eM](https://i.ytimg.com/vi/fSdDGp4R7eM/maxresdefault.jpg)](https://www.youtube.com/embed/fSdDGp4R7eM)

## Authentication
The Podscan API uses standard API key authentication. You will need to provide your API key in the `Authorization` header as a `Bearer` token. You can find your [API key in the Podscan dashboard](https://podscan.fm/user/api-tokens).

## Team
You will find your team's ID in the Podscan dashboard, in the Team dropdown menu. You will need this ID to access your team's alerts and mentions.

## Rate Limiting
The Podscan API is rate limited. If you exceed the limit, you will receive a 429 Too Many Requests response. If we detect abuse, we will block your access to the API.
Here are the rate limits for the Podscan API:
- **Trial**: 100 requests per day, 10 requests per minute, 5 concurrent
- **Essential Plan** *(legacy)*: 1000 requests per day, 60 requests per minute, 5 concurrent
- **Premium Plan**: 2000 requests per day, 120 requests per minute, 10 concurrent
- **Professional Plan**: 5000 requests per day, 120 requests per minute, 15 concurrent
- **Advanced Plan**: 10,000 requests per day, 120 requests per minute, 20 concurrent

### Pay-as-you-go metered pricing

Premium, Professional, and Advanced subscribers can turn on pay-as-you-go metered billing to keep serving requests beyond the daily limit instead of being blocked. When it is enabled:

- Requests above your plan's daily limit are **aggregated across one monthly overage period**, then rounded up once at **$5.00 per 1,000 requests**. We do not round each day separately.
- You can set optional daily and monthly spend caps. Lowering a cap can only reduce usage that has not been submitted; raising it never increases usage already recorded under a lower cap.
- Monthly and annual subscribers both settle overage monthly, anchored to the subscription billing day, as a separate Paddle transaction. The API Usage & Overage page shows the exact period and next settlement date.
- The per-minute and concurrency limits are unchanged; metered billing only lifts the daily request limit.

Enable metered billing and review your usage and charges on the **API Usage & Overage** page in your Podscan dashboard.

> *Note: The Essential plan is a legacy plan and is no longer available to new subscribers. Existing Essential subscribers retain access at the documented limits.*

## Concurrency Limiting
The API also limits the number of simultaneous requests you can have in-flight at any given time. If you exceed the concurrency limit, you will receive a 429 Too Many Requests response with `error: concurrency_limit_exceeded`. The response will include `X-Concurrency-Limit` and `Retry-After` headers.

## Restricted Fields
Depending on your plan, we may restrict access to certain fields. These fields usually contain sensitive information, such as email addresses, phone numbers, and podcast-specific audience data, and are only made available on the API for the following plans:
- **Trial**: No restrictions
- **Essential Plan** *(legacy)*:
    - Restricted on podcasts: `email`, `itunes_id`, `spotify_id`, `predicted_audience_size`, `itunes_rating_count`, `itunes_rating`, `spotify_rating_count`, `spotify_rating`
- **Premium Plan**: No restrictions
- **Advanced Plan**: No restrictions

> *Note: The Essential plan is a legacy plan and is no longer available to new subscribers. Existing Essential subscribers retain access at the documented field restrictions.*

Every request to the API will return the following headers:
- `X-RateLimit-Limit`: The maximum number of requests that the consumer is permitted to make in a 60-minute period.
- `X-RateLimit-Remaining`: The number of requests remaining in the current rate limit window.

## Errors
The Podscan API uses standard HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with Podscan's servers.

## Pagination
Requests that return multiple items will be paginated by default. You can specify further pages with the `page` parameter. For some resources, you can also set a custom page size with the `per_page` parameter.

## Final Notes
The Podscan API is a work in progress. We will be adding more endpoints and features in the future. If you have any questions or need help, please contact us at [service@podscan.fm](mailto:service@podscan.fm).


## Alert Groups

- [alert-groups.index](https://oapis.org/openapi/podscan.fm/alert-groups.index): List alert groups
- [alert-groups.store](https://oapis.org/openapi/podscan.fm/alert-groups.store): Create an alert group
- [alert-groups.show](https://oapis.org/openapi/podscan.fm/alert-groups.show): Show an alert group
- [alert-groups.update](https://oapis.org/openapi/podscan.fm/alert-groups.update): Update an alert group
- [alert-groups.destroy](https://oapis.org/openapi/podscan.fm/alert-groups.destroy): Delete an alert group
- [alert-groups.reorder](https://oapis.org/openapi/podscan.fm/alert-groups.reorder): Reorder alert groups
- [alert-groups.batch-toggle](https://oapis.org/openapi/podscan.fm/alert-groups.batch-toggle): Batch toggle alerts in a group

## AlertGroups

- [alert-groups.index](https://oapis.org/openapi/podscan.fm/alert-groups.index): List alert groups
- [alert-groups.store](https://oapis.org/openapi/podscan.fm/alert-groups.store): Create an alert group
- [alert-groups.show](https://oapis.org/openapi/podscan.fm/alert-groups.show): Show an alert group
- [alert-groups.update](https://oapis.org/openapi/podscan.fm/alert-groups.update): Update an alert group
- [alert-groups.destroy](https://oapis.org/openapi/podscan.fm/alert-groups.destroy): Delete an alert group
- [alert-groups.reorder](https://oapis.org/openapi/podscan.fm/alert-groups.reorder): Reorder alert groups
- [alert-groups.batch-toggle](https://oapis.org/openapi/podscan.fm/alert-groups.batch-toggle): Batch toggle alerts in a group

## Alerts

- [alerts.index](https://oapis.org/openapi/podscan.fm/alerts.index): List all alerts for a team
- [alerts.create](https://oapis.org/openapi/podscan.fm/alerts.create): Create a new alert
- [alerts.show](https://oapis.org/openapi/podscan.fm/alerts.show): Show a single alert
- [alerts.update](https://oapis.org/openapi/podscan.fm/alerts.update): Update an alert
- [alerts.delete](https://oapis.org/openapi/podscan.fm/alerts.delete): Delete an alert
- [alerts.mentions.export](https://oapis.org/openapi/podscan.fm/alerts.mentions.export): Export mentions for an alert as JSON or CSV
- [alerts.mentions.index](https://oapis.org/openapi/podscan.fm/alerts.mentions.index): List mentions for an alert
- [alerts.mentions.sentiment-summary](https://oapis.org/openapi/podscan.fm/alerts.mentions.sentiment-summary): Get sentiment summary for an alert's mentions
- [alerts.mentions.trends](https://oapis.org/openapi/podscan.fm/alerts.mentions.trends): Get mention volume trends for an alert
- [alerts.mentions.show](https://oapis.org/openapi/podscan.fm/alerts.mentions.show): Show a single mention

## Categories

- [categories.index](https://oapis.org/openapi/podscan.fm/categories.index): List all categories

## Category

- [categories.index](https://oapis.org/openapi/podscan.fm/categories.index): List all categories

## Category Leaders

- [category-leaders.search](https://oapis.org/openapi/podscan.fm/category-leaders.search): Search category leaders
- [category-leaders.export](https://oapis.org/openapi/podscan.fm/category-leaders.export): Export category leaders as CSV

## CategoryLeadersApi

- [category-leaders.search](https://oapis.org/openapi/podscan.fm/category-leaders.search): Search category leaders
- [category-leaders.export](https://oapis.org/openapi/podscan.fm/category-leaders.export): Export category leaders as CSV

## Charts

- [chartsApi.getAvailableCountries](https://oapis.org/openapi/podscan.fm/chartsApi.getAvailableCountries): Get available countries
- [chartsApi.getSupportedCountries](https://oapis.org/openapi/podscan.fm/chartsApi.getSupportedCountries): Get supported countries
- [chartsApi.getCategories](https://oapis.org/openapi/podscan.fm/chartsApi.getCategories): Get available categories
- [chartsApi.getByCategory](https://oapis.org/openapi/podscan.fm/chartsApi.getByCategory): Get category charts for a country
- [chartsApi.getMovements](https://oapis.org/openapi/podscan.fm/chartsApi.getMovements): Get chart movements
- [chartsApi.getTopPodcasts](https://oapis.org/openapi/podscan.fm/chartsApi.getTopPodcasts): Get top podcasts
- [chartsApi.getDemographics](https://oapis.org/openapi/podscan.fm/chartsApi.getDemographics): Get chart demographics
- [chartsApi.getByCountry](https://oapis.org/openapi/podscan.fm/chartsApi.getByCountry): Get charts for a specific country
- [chartsApi.getTrending](https://oapis.org/openapi/podscan.fm/chartsApi.getTrending): Get trending podcasts for a country

## ChartsApi

- [chartsApi.getAvailableCountries](https://oapis.org/openapi/podscan.fm/chartsApi.getAvailableCountries): Get available countries
- [chartsApi.getSupportedCountries](https://oapis.org/openapi/podscan.fm/chartsApi.getSupportedCountries): Get supported countries
- [chartsApi.getCategories](https://oapis.org/openapi/podscan.fm/chartsApi.getCategories): Get available categories
- [chartsApi.getByCategory](https://oapis.org/openapi/podscan.fm/chartsApi.getByCategory): Get category charts for a country
- [chartsApi.getMovements](https://oapis.org/openapi/podscan.fm/chartsApi.getMovements): Get chart movements
- [chartsApi.getTopPodcasts](https://oapis.org/openapi/podscan.fm/chartsApi.getTopPodcasts): Get top podcasts
- [chartsApi.getDemographics](https://oapis.org/openapi/podscan.fm/chartsApi.getDemographics): Get chart demographics
- [chartsApi.getByCountry](https://oapis.org/openapi/podscan.fm/chartsApi.getByCountry): Get charts for a specific country
- [chartsApi.getTrending](https://oapis.org/openapi/podscan.fm/chartsApi.getTrending): Get trending podcasts for a country

## Companies

- [companies.trending](https://oapis.org/openapi/podscan.fm/companies.trending): Get trending companies
- [companies.index](https://oapis.org/openapi/podscan.fm/companies.index): List and search companies
- [companies.episodes](https://oapis.org/openapi/podscan.fm/companies.episodes): Get episodes mentioning a company
- [companies.timeseries](https://oapis.org/openapi/podscan.fm/companies.timeseries): Get a company's mention time series
- [companies.show](https://oapis.org/openapi/podscan.fm/companies.show): Get a company

## ContactExportApi

- [contact-exports.categories](https://oapis.org/openapi/podscan.fm/contact-exports.categories): List available contact export categories
- [contact-exports.download](https://oapis.org/openapi/podscan.fm/contact-exports.download): Download a specific contact export file

## Entities

- [entities.search](https://oapis.org/openapi/podscan.fm/entities.search): Search entities
- [entities.show](https://oapis.org/openapi/podscan.fm/entities.show): Get entity details
- [entities.appearances](https://oapis.org/openapi/podscan.fm/entities.appearances): Get entity appearances
- [entities.similar](https://oapis.org/openapi/podscan.fm/entities.similar): Get similar entities
- [episodes.entities](https://oapis.org/openapi/podscan.fm/episodes.entities): Get episode entities

## EntityApi

- [entities.search](https://oapis.org/openapi/podscan.fm/entities.search): Search entities
- [entities.show](https://oapis.org/openapi/podscan.fm/entities.show): Get entity details
- [entities.appearances](https://oapis.org/openapi/podscan.fm/entities.appearances): Get entity appearances
- [entities.similar](https://oapis.org/openapi/podscan.fm/entities.similar): Get similar entities
- [episodes.entities](https://oapis.org/openapi/podscan.fm/episodes.entities): Get episode entities

## Episodes

- [episodes.search](https://oapis.org/openapi/podscan.fm/episodes.search): Search for episodes
- [episodes.searchByGUID_0](https://oapis.org/openapi/podscan.fm/episodes.searchByGUID_0): Search for episodes by GUID
- [episodes.search.by.GUID](https://oapis.org/openapi/podscan.fm/episodes.search.by.GUID): Search for episodes by GUID
- [episodes.search.by.enclosure-url](https://oapis.org/openapi/podscan.fm/episodes.search.by.enclosure-url): Search for episodes by enclosure URL (audio link)
- [episodes.recent](https://oapis.org/openapi/podscan.fm/episodes.recent): Get the most recent episodes
- [episodes.bulkDownloadEpisodes](https://oapis.org/openapi/podscan.fm/episodes.bulkDownloadEpisodes): Bulk download episodes
- [episodes.show](https://oapis.org/openapi/podscan.fm/episodes.show): Show a single episode
- [episodes.retranscribe](https://oapis.org/openapi/podscan.fm/episodes.retranscribe): Request retranscription
- [episodes.reanalyzeEpisode](https://oapis.org/openapi/podscan.fm/episodes.reanalyzeEpisode): Request reanalysis
- [episodes.demographics](https://oapis.org/openapi/podscan.fm/episodes.demographics): Get episode demographics
- [episodes.brand-safety](https://oapis.org/openapi/podscan.fm/episodes.brand-safety): Get detailed brand safety assessment for episode
- [episodes.engagement](https://oapis.org/openapi/podscan.fm/episodes.engagement): Get listener engagement data for an episode
- [episodes.transcript.download](https://oapis.org/openapi/podscan.fm/episodes.transcript.download): Download transcript

## ExportApi

- [exports.episodes.index](https://oapis.org/openapi/podscan.fm/exports.episodes.index): List available episode exports
- [exports.podcasts.index](https://oapis.org/openapi/podscan.fm/exports.podcasts.index): List available podcast exports
- [exports.download](https://oapis.org/openapi/podscan.fm/exports.download): Download a specific export
- [exports.formats.request](https://oapis.org/openapi/podscan.fm/exports.formats.request): Request an export in an alternate format
- [exports.formats.status](https://oapis.org/openapi/podscan.fm/exports.formats.status): Check the status of a requested export format

## Exports

- [exports.episodes.index](https://oapis.org/openapi/podscan.fm/exports.episodes.index): List available episode exports
- [exports.podcasts.index](https://oapis.org/openapi/podscan.fm/exports.podcasts.index): List available podcast exports
- [exports.download](https://oapis.org/openapi/podscan.fm/exports.download): Download a specific export
- [exports.formats.request](https://oapis.org/openapi/podscan.fm/exports.formats.request): Request an export in an alternate format
- [exports.formats.status](https://oapis.org/openapi/podscan.fm/exports.formats.status): Check the status of a requested export format
- [contact-exports.categories](https://oapis.org/openapi/podscan.fm/contact-exports.categories): List available contact export categories
- [contact-exports.download](https://oapis.org/openapi/podscan.fm/contact-exports.download): Download a specific contact export file

## IAB Categories

- [iab-categories.index](https://oapis.org/openapi/podscan.fm/iab-categories.index): List all IAB categories
- [iab-categories.show](https://oapis.org/openapi/podscan.fm/iab-categories.show): Get a single IAB category by ID

## IabCategory

- [iab-categories.index](https://oapis.org/openapi/podscan.fm/iab-categories.index): List all IAB categories
- [iab-categories.show](https://oapis.org/openapi/podscan.fm/iab-categories.show): Get a single IAB category by ID

## Lists

- [lists.index](https://oapis.org/openapi/podscan.fm/lists.index): List all lists
- [lists.create](https://oapis.org/openapi/podscan.fm/lists.create): Create a new list
- [lists.show](https://oapis.org/openapi/podscan.fm/lists.show): Show a single list & its items
- [lists.update](https://oapis.org/openapi/podscan.fm/lists.update): Update a list
- [lists.delete](https://oapis.org/openapi/podscan.fm/lists.delete): Delete a list
- [lists.items.add](https://oapis.org/openapi/podscan.fm/lists.items.add): Add item to list
- [lists.items.remove](https://oapis.org/openapi/podscan.fm/lists.items.remove): Remove item from list
- [lists.feed](https://oapis.org/openapi/podscan.fm/lists.feed): Get list feed
- [lists.demographics](https://oapis.org/openapi/podscan.fm/lists.demographics): Get list demographics
- [lists.export](https://oapis.org/openapi/podscan.fm/lists.export): Export a list
- [lists.import](https://oapis.org/openapi/podscan.fm/lists.import): Import items into a list

## ListsApi

- [lists.index](https://oapis.org/openapi/podscan.fm/lists.index): List all lists
- [lists.create](https://oapis.org/openapi/podscan.fm/lists.create): Create a new list
- [lists.show](https://oapis.org/openapi/podscan.fm/lists.show): Show a single list & its items
- [lists.update](https://oapis.org/openapi/podscan.fm/lists.update): Update a list
- [lists.delete](https://oapis.org/openapi/podscan.fm/lists.delete): Delete a list
- [lists.items.add](https://oapis.org/openapi/podscan.fm/lists.items.add): Add item to list
- [lists.items.remove](https://oapis.org/openapi/podscan.fm/lists.items.remove): Remove item from list
- [lists.feed](https://oapis.org/openapi/podscan.fm/lists.feed): Get list feed
- [lists.demographics](https://oapis.org/openapi/podscan.fm/lists.demographics): Get list demographics
- [lists.export](https://oapis.org/openapi/podscan.fm/lists.export): Export a list
- [lists.import](https://oapis.org/openapi/podscan.fm/lists.import): Import items into a list

## MentionAnalyticsApi

- [alerts.mentions.sentiment-summary](https://oapis.org/openapi/podscan.fm/alerts.mentions.sentiment-summary): Get sentiment summary for an alert's mentions
- [alerts.mentions.trends](https://oapis.org/openapi/podscan.fm/alerts.mentions.trends): Get mention volume trends for an alert

## PlatformStatsApi

- [stats](https://oapis.org/openapi/podscan.fm/stats): Get platform statistics

## Podcasts

- [podcasts.suggest](https://oapis.org/openapi/podscan.fm/podcasts.suggest): Suggest a podcast
- [podcasts.search](https://oapis.org/openapi/podscan.fm/podcasts.search): Search for podcasts
- [podcasts.rankings](https://oapis.org/openapi/podscan.fm/podcasts.rankings): Get ranked podcasts by PRS score
- [podcasts.batch-probe](https://oapis.org/openapi/podscan.fm/podcasts.batch-probe): Batch probe for latest episodes matching criteria
- [podcasts.searchPodcastByITunesId_0](https://oapis.org/openapi/podscan.fm/podcasts.searchPodcastByITunesId_0): Search for a podcast by iTunesID
- [podcasts.search.by.iTunesID](https://oapis.org/openapi/podscan.fm/podcasts.search.by.iTunesID): Search for a podcast by iTunesID
- [podcasts.searchPodcastBySpotifyId](https://oapis.org/openapi/podscan.fm/podcasts.searchPodcastBySpotifyId): Search for a podcast by SpotifyID
- [podcasts.searchPodcastByGUID](https://oapis.org/openapi/podscan.fm/podcasts.searchPodcastByGUID): Search for a podcast by GUID
- [podcasts.searchPodcastsByRssFeed_0](https://oapis.org/openapi/podscan.fm/podcasts.searchPodcastsByRssFeed_0): Search for podcasts by RSS feed URL
- [podcasts.search.by.RSS](https://oapis.org/openapi/podscan.fm/podcasts.search.by.RSS): Search for podcasts by RSS feed URL
- [podcasts.show](https://oapis.org/openapi/podscan.fm/podcasts.show): Show a single podcast
- [podcasts.related](https://oapis.org/openapi/podscan.fm/podcasts.related): List related podcasts
- [podcasts.discover](https://oapis.org/openapi/podscan.fm/podcasts.discover): Discover similar podcasts using multi-index vector similarity
- [podcasts.audience-overlap](https://oapis.org/openapi/podscan.fm/podcasts.audience-overlap): List podcasts that share an audience with the specified podcast
- [podcasts.episodes.index](https://oapis.org/openapi/podscan.fm/podcasts.episodes.index): List all episodes for a podcast
- [podcasts.retranscribeAllEpisodes](https://oapis.org/openapi/podscan.fm/podcasts.retranscribeAllEpisodes): Request retranscription and reanalysis of all episodes
- [podcasts.retranscribe-missing](https://oapis.org/openapi/podscan.fm/podcasts.retranscribe-missing): Request transcription of missing episodes
- [podcasts.reanalyze-missing](https://oapis.org/openapi/podscan.fm/podcasts.reanalyze-missing): Request analysis of missing episodes
- [podcasts.setDiarizationStatus](https://oapis.org/openapi/podscan.fm/podcasts.setDiarizationStatus): Set diarization status
- [podcasts.scan-all](https://oapis.org/openapi/podscan.fm/podcasts.scan-all): Queue a deep scan of all episodes for a podcast
- [podcasts.resummarize](https://oapis.org/openapi/podscan.fm/podcasts.resummarize): Request AI summary regeneration for a podcast
- [podcasts.latest.episode](https://oapis.org/openapi/podscan.fm/podcasts.latest.episode): Get the latest episode of a podcast
- [podcasts.latest.guest](https://oapis.org/openapi/podscan.fm/podcasts.latest.guest): Get the latest episode's guests
- [podcasts.latest.sponsor](https://oapis.org/openapi/podscan.fm/podcasts.latest.sponsor): Get the latest episode's sponsors
- [podcasts.demographics](https://oapis.org/openapi/podscan.fm/podcasts.demographics): Get demographics data
- [podcasts.brand-safety](https://oapis.org/openapi/podscan.fm/podcasts.brand-safety): Get detailed brand safety assessment for podcast
- [podcasts.chart-history](https://oapis.org/openapi/podscan.fm/podcasts.chart-history): Get chart position history for a podcast
- [podcasts.analysis](https://oapis.org/openapi/podscan.fm/podcasts.analysis): Get podcast analysis

## Publishers

- [publishers.search](https://oapis.org/openapi/podscan.fm/publishers.search): Search publishers
- [publishers.show](https://oapis.org/openapi/podscan.fm/publishers.show): Get publisher details
- [publishers.podcasts](https://oapis.org/openapi/podscan.fm/publishers.podcasts): Get publisher podcasts

## PublishersApi

- [publishers.search](https://oapis.org/openapi/podscan.fm/publishers.search): Search publishers
- [publishers.show](https://oapis.org/openapi/podscan.fm/publishers.show): Get publisher details
- [publishers.podcasts](https://oapis.org/openapi/podscan.fm/publishers.podcasts): Get publisher podcasts

## Reports

- [reports.index](https://oapis.org/openapi/podscan.fm/reports.index): List all reports for a team
- [reports.create](https://oapis.org/openapi/podscan.fm/reports.create): Create a new report
- [reports.show](https://oapis.org/openapi/podscan.fm/reports.show): Show a single report
- [reports.delete](https://oapis.org/openapi/podscan.fm/reports.delete): Delete a report
- [reports.status](https://oapis.org/openapi/podscan.fm/reports.status): Get report status
- [reports.cancel](https://oapis.org/openapi/podscan.fm/reports.cancel): Cancel a report
- [reports.retry](https://oapis.org/openapi/podscan.fm/reports.retry): Retry a report
- [reports.export](https://oapis.org/openapi/podscan.fm/reports.export): Export report results
- [reports.share](https://oapis.org/openapi/podscan.fm/reports.share): Share a report
- [reports.unshare](https://oapis.org/openapi/podscan.fm/reports.unshare): Unshare a report

## ReportsApi

- [reports.index](https://oapis.org/openapi/podscan.fm/reports.index): List all reports for a team
- [reports.create](https://oapis.org/openapi/podscan.fm/reports.create): Create a new report
- [reports.show](https://oapis.org/openapi/podscan.fm/reports.show): Show a single report
- [reports.delete](https://oapis.org/openapi/podscan.fm/reports.delete): Delete a report
- [reports.status](https://oapis.org/openapi/podscan.fm/reports.status): Get report status
- [reports.cancel](https://oapis.org/openapi/podscan.fm/reports.cancel): Cancel a report
- [reports.retry](https://oapis.org/openapi/podscan.fm/reports.retry): Retry a report
- [reports.export](https://oapis.org/openapi/podscan.fm/reports.export): Export report results
- [reports.share](https://oapis.org/openapi/podscan.fm/reports.share): Share a report
- [reports.unshare](https://oapis.org/openapi/podscan.fm/reports.unshare): Unshare a report

## ReportTemplatesApi

- [reports.compare](https://oapis.org/openapi/podscan.fm/reports.compare): Compare two reports
- [report-templates.index](https://oapis.org/openapi/podscan.fm/report-templates.index): List all report templates for a team
- [report-templates.create](https://oapis.org/openapi/podscan.fm/report-templates.create): Create a new report template
- [report-templates.show](https://oapis.org/openapi/podscan.fm/report-templates.show): Show a single report template
- [report-templates.update](https://oapis.org/openapi/podscan.fm/report-templates.update): Update a report template
- [report-templates.delete](https://oapis.org/openapi/podscan.fm/report-templates.delete): Delete a report template

## SearchApi

- [search.advanced](https://oapis.org/openapi/podscan.fm/search.advanced): Advanced episode search with multi-field filters
- [search.deep](https://oapis.org/openapi/podscan.fm/search.deep): Deep full-text search across transcripts
- [search.direct](https://oapis.org/openapi/podscan.fm/search.direct): Direct lookup by RSS URL, iTunes ID, Spotify ID, or podcast GUID

## Share of Voice

- [sov.sets.index](https://oapis.org/openapi/podscan.fm/sov.sets.index): List competitive sets for a team
- [sov.sets.create](https://oapis.org/openapi/podscan.fm/sov.sets.create): Create a new competitive set
- [sov.sets.show](https://oapis.org/openapi/podscan.fm/sov.sets.show): Get a competitive set's details
- [sov.sets.update](https://oapis.org/openapi/podscan.fm/sov.sets.update): Update a competitive set
- [sov.sets.delete](https://oapis.org/openapi/podscan.fm/sov.sets.delete): Delete a competitive set and all its data
- [sov.brands.create](https://oapis.org/openapi/podscan.fm/sov.brands.create): Add a brand/competitor to a set
- [sov.brands.update](https://oapis.org/openapi/podscan.fm/sov.brands.update): Update a brand in a set
- [sov.brands.delete](https://oapis.org/openapi/podscan.fm/sov.brands.delete): Remove a brand from a set
- [sov.data](https://oapis.org/openapi/podscan.fm/sov.data): Get SOV breakdown data for a competitive set
- [sov.timeseries](https://oapis.org/openapi/podscan.fm/sov.timeseries): Get SOV time-series chart data
- [sov.sentiment](https://oapis.org/openapi/podscan.fm/sov.sentiment): Get sentiment breakdown data
- [sov.keyword-matches](https://oapis.org/openapi/podscan.fm/sov.keyword-matches): Get keyword match details for a brand (drill-down)
- [sov.export](https://oapis.org/openapi/podscan.fm/sov.export): Export SOV data as CSV
- [sov.export.keyword-matches](https://oapis.org/openapi/podscan.fm/sov.export.keyword-matches): Export keyword match data for a brand as CSV
- [sov.export.sentiment](https://oapis.org/openapi/podscan.fm/sov.export.sentiment): Export sentiment breakdown data as CSV
- [sov.export.timeseries](https://oapis.org/openapi/podscan.fm/sov.export.timeseries): Export time-series SOV data as CSV

## ShareOfVoiceApi

- [sov.sets.index](https://oapis.org/openapi/podscan.fm/sov.sets.index): List competitive sets for a team
- [sov.sets.create](https://oapis.org/openapi/podscan.fm/sov.sets.create): Create a new competitive set
- [sov.sets.show](https://oapis.org/openapi/podscan.fm/sov.sets.show): Get a competitive set's details
- [sov.sets.update](https://oapis.org/openapi/podscan.fm/sov.sets.update): Update a competitive set
- [sov.sets.delete](https://oapis.org/openapi/podscan.fm/sov.sets.delete): Delete a competitive set and all its data
- [sov.brands.create](https://oapis.org/openapi/podscan.fm/sov.brands.create): Add a brand/competitor to a set
- [sov.brands.update](https://oapis.org/openapi/podscan.fm/sov.brands.update): Update a brand in a set
- [sov.brands.delete](https://oapis.org/openapi/podscan.fm/sov.brands.delete): Remove a brand from a set
- [sov.data](https://oapis.org/openapi/podscan.fm/sov.data): Get SOV breakdown data for a competitive set
- [sov.timeseries](https://oapis.org/openapi/podscan.fm/sov.timeseries): Get SOV time-series chart data
- [sov.sentiment](https://oapis.org/openapi/podscan.fm/sov.sentiment): Get sentiment breakdown data
- [sov.keyword-matches](https://oapis.org/openapi/podscan.fm/sov.keyword-matches): Get keyword match details for a brand (drill-down)
- [sov.export](https://oapis.org/openapi/podscan.fm/sov.export): Export SOV data as CSV
- [sov.export.keyword-matches](https://oapis.org/openapi/podscan.fm/sov.export.keyword-matches): Export keyword match data for a brand as CSV
- [sov.export.sentiment](https://oapis.org/openapi/podscan.fm/sov.export.sentiment): Export sentiment breakdown data as CSV
- [sov.export.timeseries](https://oapis.org/openapi/podscan.fm/sov.export.timeseries): Export time-series SOV data as CSV

## Sponsor Alerts

- [sponsor-alerts.index](https://oapis.org/openapi/podscan.fm/sponsor-alerts.index): 
- [sponsor-alerts.create](https://oapis.org/openapi/podscan.fm/sponsor-alerts.create): 
- [sponsor-alerts.appearances.index](https://oapis.org/openapi/podscan.fm/sponsor-alerts.appearances.index): 
- [sponsor-alerts.appearances.show](https://oapis.org/openapi/podscan.fm/sponsor-alerts.appearances.show): 
- [sponsor-alerts.show](https://oapis.org/openapi/podscan.fm/sponsor-alerts.show): 
- [sponsor-alerts.update](https://oapis.org/openapi/podscan.fm/sponsor-alerts.update): 
- [sponsor-alerts.delete](https://oapis.org/openapi/podscan.fm/sponsor-alerts.delete): 

## SponsorAlerts

- [sponsor-alerts.index](https://oapis.org/openapi/podscan.fm/sponsor-alerts.index): 
- [sponsor-alerts.create](https://oapis.org/openapi/podscan.fm/sponsor-alerts.create): 
- [sponsor-alerts.appearances.index](https://oapis.org/openapi/podscan.fm/sponsor-alerts.appearances.index): 
- [sponsor-alerts.appearances.show](https://oapis.org/openapi/podscan.fm/sponsor-alerts.appearances.show): 
- [sponsor-alerts.show](https://oapis.org/openapi/podscan.fm/sponsor-alerts.show): 
- [sponsor-alerts.update](https://oapis.org/openapi/podscan.fm/sponsor-alerts.update): 
- [sponsor-alerts.delete](https://oapis.org/openapi/podscan.fm/sponsor-alerts.delete): 

## Sponsors

- [sponsors.index](https://oapis.org/openapi/podscan.fm/sponsors.index): Browse top sponsors
- [sponsors.search](https://oapis.org/openapi/podscan.fm/sponsors.search): Search sponsors
- [sponsors.show](https://oapis.org/openapi/podscan.fm/sponsors.show): Get sponsor profile
- [sponsors.podcasts](https://oapis.org/openapi/podscan.fm/sponsors.podcasts): Get sponsored podcasts
- [sponsors.podcasts.episodes](https://oapis.org/openapi/podscan.fm/sponsors.podcasts.episodes): Get recent sponsored episodes for a specific podcast
- [sponsors.trend](https://oapis.org/openapi/podscan.fm/sponsors.trend): Get sponsor trend data

## SponsorsApi

- [sponsors.index](https://oapis.org/openapi/podscan.fm/sponsors.index): Browse top sponsors
- [sponsors.search](https://oapis.org/openapi/podscan.fm/sponsors.search): Search sponsors
- [sponsors.show](https://oapis.org/openapi/podscan.fm/sponsors.show): Get sponsor profile
- [sponsors.podcasts](https://oapis.org/openapi/podscan.fm/sponsors.podcasts): Get sponsored podcasts
- [sponsors.podcasts.episodes](https://oapis.org/openapi/podscan.fm/sponsors.podcasts.episodes): Get recent sponsored episodes for a specific podcast
- [sponsors.trend](https://oapis.org/openapi/podscan.fm/sponsors.trend): Get sponsor trend data

## Teams

- [teams.index](https://oapis.org/openapi/podscan.fm/teams.index): List all teams
- [webhooks.index](https://oapis.org/openapi/podscan.fm/webhooks.index): List active webhooks
- [teams.firehose.settings.show](https://oapis.org/openapi/podscan.fm/teams.firehose.settings.show): Get firehose settings
- [teams.firehose.settings.update](https://oapis.org/openapi/podscan.fm/teams.firehose.settings.update): Update firehose settings

## Ticker Alerts

- [ticker-alerts.index](https://oapis.org/openapi/podscan.fm/ticker-alerts.index): 
- [ticker-alerts.create](https://oapis.org/openapi/podscan.fm/ticker-alerts.create): Create a ticker alert
- [ticker-alerts.mentions.index](https://oapis.org/openapi/podscan.fm/ticker-alerts.mentions.index): 
- [ticker-alerts.mentions.show](https://oapis.org/openapi/podscan.fm/ticker-alerts.mentions.show): 
- [ticker-alerts.show](https://oapis.org/openapi/podscan.fm/ticker-alerts.show): 
- [ticker-alerts.update](https://oapis.org/openapi/podscan.fm/ticker-alerts.update): 
- [ticker-alerts.delete](https://oapis.org/openapi/podscan.fm/ticker-alerts.delete): 

## TickerAlerts

- [ticker-alerts.index](https://oapis.org/openapi/podscan.fm/ticker-alerts.index): 
- [ticker-alerts.create](https://oapis.org/openapi/podscan.fm/ticker-alerts.create): Create a ticker alert
- [ticker-alerts.mentions.index](https://oapis.org/openapi/podscan.fm/ticker-alerts.mentions.index): 
- [ticker-alerts.mentions.show](https://oapis.org/openapi/podscan.fm/ticker-alerts.mentions.show): 
- [ticker-alerts.show](https://oapis.org/openapi/podscan.fm/ticker-alerts.show): 
- [ticker-alerts.update](https://oapis.org/openapi/podscan.fm/ticker-alerts.update): 
- [ticker-alerts.delete](https://oapis.org/openapi/podscan.fm/ticker-alerts.delete): 

## Topic Collections

- [topic-collections.index](https://oapis.org/openapi/podscan.fm/topic-collections.index): List topic collections
- [topic-collections.show](https://oapis.org/openapi/podscan.fm/topic-collections.show): Show a topic collection

## TopicCollectionApi

- [topic-collections.index](https://oapis.org/openapi/podscan.fm/topic-collections.index): List topic collections
- [topic-collections.show](https://oapis.org/openapi/podscan.fm/topic-collections.show): Show a topic collection

## Topics

- [topics.trending](https://oapis.org/openapi/podscan.fm/topics.trending): Get trending topics
- [topics.trending.export](https://oapis.org/openapi/podscan.fm/topics.trending.export): Export trending topics
- [topics.search](https://oapis.org/openapi/podscan.fm/topics.search): Search topics
- [topics.show](https://oapis.org/openapi/podscan.fm/topics.show): Get topic details
- [topics.related](https://oapis.org/openapi/podscan.fm/topics.related): Get related topics
- [topics.episodes](https://oapis.org/openapi/podscan.fm/topics.episodes): Get latest episodes for a topic
- [topics.demographics](https://oapis.org/openapi/podscan.fm/topics.demographics): Get audience demographics for a topic

## TopicsApi

- [topics.trending](https://oapis.org/openapi/podscan.fm/topics.trending): Get trending topics
- [topics.trending.export](https://oapis.org/openapi/podscan.fm/topics.trending.export): Export trending topics
- [topics.search](https://oapis.org/openapi/podscan.fm/topics.search): Search topics
- [topics.show](https://oapis.org/openapi/podscan.fm/topics.show): Get topic details
- [topics.related](https://oapis.org/openapi/podscan.fm/topics.related): Get related topics
- [topics.episodes](https://oapis.org/openapi/podscan.fm/topics.episodes): Get latest episodes for a topic
- [topics.demographics](https://oapis.org/openapi/podscan.fm/topics.demographics): Get audience demographics for a topic

## WebhookLogsApi

- [webhook-logs.alerts.index](https://oapis.org/openapi/podscan.fm/webhook-logs.alerts.index): List alert webhook deliveries
- [webhook-logs.alerts.show](https://oapis.org/openapi/podscan.fm/webhook-logs.alerts.show): Get alert webhook delivery details
- [webhook-logs.collections.index](https://oapis.org/openapi/podscan.fm/webhook-logs.collections.index): List collection webhook deliveries
- [webhook-logs.collections.show](https://oapis.org/openapi/podscan.fm/webhook-logs.collections.show): Get collection webhook delivery details
- [webhook-logs.firehose.index](https://oapis.org/openapi/podscan.fm/webhook-logs.firehose.index): List firehose webhook deliveries
- [webhook-logs.firehose.show](https://oapis.org/openapi/podscan.fm/webhook-logs.firehose.show): Get firehose delivery details
- [webhook-logs.firehose.replay](https://oapis.org/openapi/podscan.fm/webhook-logs.firehose.replay): Replay a firehose delivery