Alert Matches

GET https://api.podengine.ai/api/v1/alerts/matches

Get your team's alert matches, one per episode, newest first. Each match lists its mentions with the time, a snippet, the ad and wrong-person check labels, and a link that plays from that moment. Set includeFiltered to also see the episodes and mentions your alert filters removed, and why.

Request

Query parameters

Only matches for this alert configuration.

Include episodes and mentions the alert filters removed, with the labels that removed them. Defaults to false.

pagenumbermin 1

Page of episodes to return. Defaults to 1.

pageSizenumber1 – 50

Episodes per page, up to 50. Defaults to 25.

Response

200 application/json
statusliteral: OKrequired
dataobjectrequired3 fields
optionsobjectrequired4 fields

Only matches for this alert configuration.

Include episodes and mentions the alert filters removed, with the labels that removed them. Defaults to false.

pagenumbermin 1

Page of episodes to return. Defaults to 1.

pageSizenumber1 – 50

Episodes per page, up to 50. Defaults to 25.

totalnumberrequired

Episodes matching the options, across all pages.

matchesarray of objectrequired13 fields
idstringrequired
alertConfigobjectrequired3 fields
idstringrequired
namestringrequired
typeenumrequired
personcompanycustom-keyword
statusenumrequired
keptfiltered
filterReasonsarray of enumrequired

Why the episode was filtered: the reasons of its mentions combined. Empty when kept.

adnot_subjectuncheckedlegacy_context_check
episodeobjectrequired5 fields
idstringrequired
slugstringrequired
titlestringrequired
publishedAtdaterequired
imageUrlstringrequirednullable
podcastobjectrequired3 fields
idstringrequired
slugstringrequired
titlestringrequired
appearanceobjectrequirednullable2 fields
roleenumrequirednullable
guesthostmentionedunknown
sourceenumrequired
people_datatitle_description
subjectCheckenumrequirednullable

Person and company alerts: "checked" when mentions about someone else with the same name are filtered out, "unverified" when they are not (the alert has no "Who is this?" note that passed the check). Null for keyword alerts.

checkedunverified
mentionCountnumberrequired
keptMentionCountnumberrequired
syndicatedEpisodeIdsarray of stringrequired
firstMatchedAtdaterequired
mentionsarray of objectrequired7 fields

Mentions that pass the alert filters, earliest first; filtered ones too when includeFiltered is set.

idstringrequired
startSecondnumberrequirednullable
snippetstringrequired
passesFiltersbooleanrequired
filterReasonsarray of enumrequired
adnot_subjectuncheckedlegacy_context_check
labelsarray of objectrequired4 fields
classifierenumrequired
isAdisSubject
labelstringrequired

The classifier label, e.g. "sponsor_read" or "not_about".

probabilitynumberrequired0 – 1
filteredOutbooleanrequired

Whether this label removed the mention under the alert filters.

playUrlstringrequiredurl