Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

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

Path Parameters

previewId
string
required

Opaque preview ID returned by POST /v1/projects/{projectId}/alerts/preview.

Response

OK

started_at
string<date-time>
required
status
enum<string>
required

State of the sweep. Clients should poll until the value is 'completed' or 'failed' (TTL 1h).

Available options:
in_progress,
completed,
failed
total_matches
integer<int64>
required
window_days
integer<int64>
required
by_day
object[] | null

Per-day match count over the window (UTC dates), oldest day first.

completed_at
string<date-time>

Set once status is completed or failed.

error
string

Set only when status is failed; safe to surface to the user.

sample
object[] | null

Up to AlertPreviewSampleSize most-recent matches with payload fully hydrated. Empty until status is completed.