Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

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

Path Parameters

projectId
string
required

Project ID.

Query Parameters

window_days
integer<int64>

Number of days back to sweep. Defaults to 7; capped at 30.

Example:

7

Body

application/json
entities
object[] | null
required

Same as CreateAlertBody.entities.

Required array length: 1 - 100 elements
filters
object

Same as CreateAlertBody.filters. Pass the filters you intend to save so the estimate reflects what the alert would actually surface. Only languages and speaker_roles narrow the historical sweep; relevance and source_popularity are read-time projections that don't run on historical episodes, so setting them leaves the count unchanged (the estimate is an upper bound when relevance=RELEVANT).

kind
enum<string>

Same as CreateAlertBody.kind. Defaults to ENTITY_MENTION.

Available options:
ENTITY_MENTION,
PODCAST_SPEAKER

Response

OK

preview_id
string
required

Deterministic preview ID — repeating the same body within the TTL returns the same ID. Poll GET /v1/alerts/preview/{previewId} when status is 'in_progress'.

status
enum<string>
required

'in_progress' means a sweep is running (or was just started); 'completed' means an earlier identical preview is still cached and the result is ready to fetch via GET. A 'failed' prior preview is treated as a cache miss and a fresh sweep is started — callers never see 'failed' on this endpoint.

Available options:
in_progress,
completed
window_days
integer<int64>
required