Alerts
tier:standard

Get the status and result of an alert preview

Returns the current state of an async preview sweep. Status transitions in_progress → completed (or failed). Previews are retained for 1 hour; expired IDs return 404.

get/v1/alerts/preview/{previewId}

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/alerts/preview/{previewId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

previewIdstring required

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

Response

OK

completed_atstring date-time

Set once status is completed or failed.

errorstring

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

started_atstring date-time required
status'in_progress' | 'completed' | 'failed' required

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

total_matchesinteger required
window_daysinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.