Skip to main content
GET
/
v1
/
alerts
/
preview
/
{previewId}
cURL
curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/alerts/preview/{previewId}"
{
  "started_at": "2023-11-07T05:31:56Z",
  "total_matches": 123,
  "window_days": 123,
  "by_day": [
    {
      "count": 123,
      "date": "<string>"
    }
  ],
  "completed_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "sample": [
    {
      "alert_id": "<string>",
      "deliveries": [
        {
          "channel": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "status": "<string>",
          "error_message": "<string>",
          "sent_at": "2023-11-07T05:31:56Z"
        }
      ],
      "detected_at": "2023-11-07T05:31:56Z",
      "entity_id": "<string>",
      "entity_type": "<string>",
      "id": "<string>",
      "mention_count": 123,
      "monitor_id": "<string>",
      "source_id": "<string>",
      "source_type": "<string>",
      "episode": {
        "podcast_id": "<string>",
        "podcast_title": "<string>",
        "title": "<string>",
        "apple_podcasts_url": "<string>",
        "duration_seconds": 123,
        "explicit": true,
        "image_url": "<string>",
        "podcast_image_url": "<string>",
        "podcast_slug": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "slug": "<string>"
      },
      "is_backfilled": true,
      "llm_summary": "<string>",
      "mention_variants": [
        "<string>"
      ],
      "roles": [
        "<string>"
      ],
      "salience": 123,
      "truncated": true,
      "windows": [
        {
          "end_seconds": 123,
          "lines": [
            {
              "end_seconds": 123,
              "start_seconds": 123,
              "text": "<string>",
              "is_mention": true,
              "number": 123,
              "role": "<string>",
              "speaker": "<string>"
            }
          ],
          "start_seconds": 123,
          "segment_id": "<string>",
          "segment_title": "<string>",
          "segment_type": "<string>"
        }
      ]
    }
  ]
}

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.