v1

latestOpenAPI 3.0.12026-07-2491247233.8 KB
Message Groups

Get SIEM-oriented summary of flagged message groups

Returns a paginated, reduced-field summary of flagged message groups intended for SIEM ingestion. Array fields are bounded to keep payloads under typical SIEM batch limits.

get/v0/message-groups/siem-summary

Query parameters

cursorstring nullable

Opaque pagination cursor returned in the previous response's cursor field.

Opaque pagination cursor returned in the previous response's cursor field.

limitinteger

The maximum number of message groups to return.

The maximum number of message groups to return.

timestamp__gtestring date-time nullable

Inclusive lower bound on the sort timestamp (newest_created_at for type=flagged, first_reported_as_phish_at for type=reported).

Inclusive lower bound on the sort timestamp (newest_created_at for type=flagged, first_reported_as_phish_at for type=reported).

timestamp__ltstring date-time nullable

Exclusive upper bound on the sort timestamp (newest_created_at for type=flagged, first_reported_as_phish_at for type=reported).

Exclusive upper bound on the sort timestamp (newest_created_at for type=flagged, first_reported_as_phish_at for type=reported).

type'flagged' | 'reported'

Which timestamp the endpoint sorts/filters on: 'flagged' uses newest_created_at, 'reported' uses first_reported_as_phish_at.

Which timestamp the endpoint sorts/filters on: 'flagged' uses newest_created_at, 'reported' uses first_reported_as_phish_at.

Response

OK

cursorstring nullable

Opaque cursor for the next page; pass it back as the cursor query param. Null when no more pages are available.