Single Campaign Reporting
const url = 'https://backend.podscribe.ai/api/public/campaign/example?unique_ads_only=false&include_episode_descriptions=false&include_pinned_comments=false&matched_promo_ads_only=false&include_ad_transcripts=false';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://backend.podscribe.ai/api/public/campaign/example?unique_ads_only=false&include_episode_descriptions=false&include_pinned_comments=false&matched_promo_ads_only=false&include_ad_transcripts=false' \ --header 'Authorization: Bearer <token>'Example:
curl -sS -G 'https://backend.podscribe.ai/api/public/campaign/{request_id}' \
--data-urlencode 'unique_ads_only=true' \
-H 'Authorization: Bearer <YOUR_API_KEY>' \
-H 'Accept: application/json'Replace {request_id} with the campaign ID or external ID. Omit unique_ads_only (or set false) to return all ads.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Campaign ID or external ID
Query Parameters
Section titled “Query Parameters”When true, returns only unique ads (transcript-similarity grouping); defaults to false
When true, each ad in the response includes the source episode description; defaults to false
When true, each ad in the response includes the pinned comment for the source episode (when available); defaults to false
When true, returns only ads whose promo matches the campaign promo (campaigns without promo keep all ads); defaults to false
When true, each ad in the response includes the transcript text; defaults to false
Responses
Section titled “Responses”OK
object
object
The external id of the campaign.
The request id of the campaign.
The end date of the campaign.
The start date of the campaign.
The expected date of the campaign.
The geo of audience for the campaign.
The discount code for the campaign.
The category of the campaign.
The agency name
The rate in USD for the campaign.
Currency code (USD, EUR, GBP)
Exchange rate from currency to USD (calculated automatically on the backend)
The expected impressions for the campaign.
The series publisher.
The advertiser name.
The placement name for the campaign.
The date and time the prefix was placed.
The advertiser lookup name.
The series ID in the Podscribe platform.
Itunes Id
The youtube series ID in the Podscribe platform.
Spotify Video opt-in date, ISO 8601 date-time.
The campaign name.
object
The ad ID in the Podscribe platform.
The episode title.
The episode ID in the Podscribe platform.
The episode duration
The series title.
The platform the ad is placed on.
The publisher of the series.
The date when the episode has been downloaded and transcribed.
The URL of the audio file for the ad.
The URL of the transcript file for the ad.
The start timestamp of the ad in the episode.
The end timestamp of the ad in the episode.
The URL of the episode in the feed.
The public link to the ad.
The placement number of the ad.
The placement group number of the ad.
The placement group in number of the ad.
The placement percent of the ad in the episode.
The full transcript text of the ad; only present when include_ad_transcripts=true is passed in the request.
object
The ad ID in the Podscribe platform.
The flags for the ad.
Competitor ads found for this ad, across all competitor flag types, one entry per competitor and episode. Empty when no competitor flag was raised. Distinct from ads[].competitors, which lists competitor lookup names on the ad itself rather than the competitor placements behind the flag.
object
The competitor’s advertiser display name.
Publish date of the episode the competitor ad was found in.
When Podscribe downloaded that competitor episode’s transcript. Distinct from ads[].transcriptionCreatedAt, which is the transcript date of the ad itself. Null for ads evaluated before this field was recorded.
object
object
The total number of downloads for the campaign.
The total number of youtube views for the campaign.
The downloads by day for the campaign.
object
The date with the format like 2023-05-03.
The impressions for current day.
The views by day for the campaign.
object
The date with the format like 2023-05-03.
The views for current day.
Total Instagram views for the campaign.
Instagram views by day for the campaign.
object
The date with the format like 2023-05-03.
Instagram views for the day.
Total Instagram likes for the campaign.
Instagram likes by day for the campaign.
object
The date with the format like 2023-05-03.
Instagram likes for the day.
Total Instagram comments for the campaign.
Instagram comments by day for the campaign.
object
The date with the format like 2023-05-03.
Instagram comments for the day.
Total TikTok views for the campaign.
TikTok views by day for the campaign.
object
The date with the format like 2023-05-03.
TikTok views for the day.
Total TikTok likes for the campaign.
TikTok likes by day for the campaign.
object
The date with the format like 2023-05-03.
TikTok likes for the day.
Total TikTok comments for the campaign.
TikTok comments by day for the campaign.
object
The date with the format like 2023-05-03.
TikTok comments for the day.
Total Twitch views for the campaign.
Twitch views by day for the campaign.
object
The date with the format like 2023-05-03.
Twitch views for the day.
Object with keys as episode ids and values as list of data by day for the episode.
object
List of data by day for the episode.
Data by day for the episode.
object
The start date with the format like 2023-05-03.
The impressions for episode of current day.
The YouTube views for episode of current day.
The reach for the campaign.
The downloads frequency for the campaign.
object
The number of visitors for the campaign.
The number of visits for the campaign.
The number of signups for the campaign.
The conversions for the campaign.
The revenue for the campaign.
object
The date by which the visitors were counted.
The number of visitors.
object
The date by which the visits were counted.
The number of visits.
object
The date by which the signups were counted.
The number of signups.
object
The date by which the conversions were counted.
The number of conversions.
object
The date by which the revenue was counted.
The revenue.
Example
{ "meta": { "currency": "USD" }}Unprocessable Entity
Unexpected error.
object
Nodejs Error
object
Examplegenerated
{ "message": {}}