latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Alerts

Get all alerts of the current user's feed (V2)

Retrieve all alerts for targets that are in collections with feed delivery enabled. Results are ordered by newest first. V2 uses the same filtering and feed logic as the Prewave dashboard.

Response: A Page containing a list of alert objects. Standard pagination fields: content, totalElements, totalPages, size, number, first, last. Each alert includes id, title, timestamps (ISO 8601 UTC), event, priority, classification, locations, links, media, primary/mentioned targets, collection paths, and optional geo (see includeGeo).

Pagination: Use query parameters page (0-based index) and size (items per page). Default page size is 20 when not specified.

Required permission: access_public_user_feed

Note: Geographic information (geo) is only included when includeGeo=true. Fields with null values are omitted from the JSON response.


Migration from V1 (/public/v1/feed)

What changed

AspectV1V2
URL/public/v1/feed/public/v2/feed
CollectionscollectionId (singular)collectionIds (plural); same comma-separated IDs
Date filterfrom or newerThan (milliseconds)from only; UTC ISO 8601 (e.g. 2024-01-01T00:00:00Z)
Omit date(varies)Last 90 days of data
Timestamps in responseNumeric (e.g. milliseconds)ISO 8601 strings in UTC for createdAt, predictedAtStart, predictedAtEnd

What is new in V2

  • Tier control: minTier and maxTier to include specific supply chain tiers (Tier 1 = direct suppliers, Tier 2 = their suppliers, etc.). Omit both for Tier 1 only (default).
  • Classification: isSituationReport, active, relevancy on each alert.
  • Structured metadata: eventTypes, eventTypeGroups, alertTypes, labels—easier to filter and display than the previous infotags list.
  • Context: mentionedTargets, previousAlerts, flagged, useCaseDetails for richer context.
  • Performance: V2 is significantly faster than V1—lower latency and higher throughput.

What is removed in V2

  • statusId — no longer returned.
  • infotags — use the new structured fields instead: eventTypes, eventTypeGroups, alertTypes, labels.
get/public/v2/feed

Query parameters

collectionIdsinteger[]

Collection IDs to filter the feed by. Only alerts for targets in these collections will be returned. In V1 this was collectionId (singular); same comma-separated IDs.

fromstring date-time

Start of the date range (inclusive). Use UTC ISO 8601 format (e.g. 2024-01-01T00:00:00Z). If omitted, V2 returns alerts from the last 90 days filtered by createdAt. In V1 you could use newerThan (milliseconds) or from; V2 uses from only.

perspectiveIdinteger

Perspective ID to filter the feed by. Defaults to the user's default perspective.

prioritiesPriority[]

List of priorities to filter the feed by Allowed values: Low, Mid, High, Critical (comma-separated).

includeGeoboolean

If set to true, the response will include the geo information. Set to true when you need coordinates or shapes for mapping.

impactLevelIdsinteger[]

Impact level IDs to filter the feed by. Valid IDs depend on your tenant configuration.

minTierinteger

Minimum supply chain tier depth to include (V2 only). Tier 1 = direct suppliers, Tier 2 = their suppliers, etc. Default 1. Must be ≤ maxTier; max value 5.

maxTierinteger

Maximum supply chain tier depth to include (V2 only). Tier 1 = direct suppliers, Tier 2 = their suppliers, etc. Default 1. Must be ≥ minTier; max value 5.

pageinteger
sizeinteger
sortstring[]

Response

Successfully retrieved alerts

totalPagesinteger
totalElementsinteger
sizeinteger
numberinteger
firstboolean
lastboolean
numberOfElementsinteger
emptyboolean