Skip to main content
GET
Get Brief
Returns radar and signal events in a single response, eliminating the need for two separate API calls.
Brief endpoints are available only on plans that include the Shoal brief surface.

Query Parameters

Request

cURL

Compact Request

cURL

Response (200)

New integrations should build against the canonical event aliases shown above. Legacy fields such as globalSummary, latestPostTimestamp, and signal are still returned as compatibility fields during the transition.

Errors