Sign in

v1

latestOpenAPI 3.0.12026-07-2491247233.8 KB
Message Groups

List message groups

List message groups

get/v0/message-groups

Query parameters

attachment_name__isstring[]

Filters result to only message groups with the provided attachment name

Filters result to only message groups with the provided attachment name

attachment_sha256__isstring[]

Filters result to only message groups with the provided attachment SHA256

Filters result to only message groups with the provided attachment SHA256

attack_score_verdict__isstring[]

Filters result to only message groups with the provided attack score verdict

Filters result to only message groups with the provided attack score verdict

attack_surface_reduction__filterstring bool nullable

Filters result to only message groups that have flagged (ONLY) rules with the 'Attack surface reduction' tag

Filters result to only message groups that have flagged (ONLY) rules with the 'Attack surface reduction' tag

canonical_id__isstring[]

Filters result to only message groups with the provided canonical ID

Filters result to only message groups with the provided canonical ID

created_at__gtestring date-time nullable

Inclusive start datetime filter, in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z'). Only message groups that contain a message processed at or after this time will be returned.

Inclusive start datetime filter, in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z'). Only message groups that contain a message processed at or after this time will be returned.

created_at__ltstring date-time nullable

Exclusive end datetime filter, in UTC using the ISO 8601 format (e.g., '2021-05-04T15:09:26Z'). Only message groups that contain a message processed before this time will be returned.

Exclusive end datetime filter, in UTC using the ISO 8601 format (e.g., '2021-05-04T15:09:26Z'). Only message groups that contain a message processed before this time will be returned.

first_message_reported_at[gte]string date-time nullable

DEPRECATED: Use first_message_reported_at__gte

DEPRECATED: Use first_message_reported_at__gte

first_message_reported_at__gtestring date-time nullable

Filters result to only message groups with a message first reported at or after the provided time. Datetime must be in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z').

Filters result to only message groups with a message first reported at or after the provided time. Datetime must be in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z').

flaggedboolean nullable

Filters result to only message groups with at least one flagged message

Filters result to only message groups with at least one flagged message

flagged_rule_id__isstring[]

Filters result to only message groups with the provided flagged rule ID

Filters result to only message groups with the provided flagged rule ID

flagged_rule_severity__isstring[]

Filters result to only message groups with the provided flagged rule severity

Filters result to only message groups with the provided flagged rule severity

historically_flagged_rule_id__isstring[]

Filters result to only message groups with the provided historically flagged rule ID

Filters result to only message groups with the provided historically flagged rule ID

historically_flagged_rule_severity__isstring[]

Filters result to only message groups with the provided historically flagged rule severity

Filters result to only message groups with the provided historically flagged rule severity

last_message_created_at[gte]string date-time nullable

DEPRECATED: Use created_at__gte instead

DEPRECATED: Use created_at__gte instead

limitinteger nullable

The maximum number of message groups to return. If the value exceeds the maximum, then the maximum value will be used.

The maximum number of message groups to return. If the value exceeds the maximum, then the maximum value will be used.

mailbox_email__isstring[]

Filters result to only message groups with the provided mailbox email

Filters result to only message groups with the provided mailbox email

offsetinteger nullable

The (zero-based) offset of the message groups to return

The (zero-based) offset of the message groups to return

recipient_email__isstring[]

Filters result to only message groups with the provided recipient email

Filters result to only message groups with the provided recipient email

reported_as_phish_by__isstring[]

Filters result to only message groups with the provided reporter

Filters result to only message groups with the provided reporter

reviewedboolean nullable

Filters result to only message groups which have or have not been reviewed

Filters result to only message groups which have or have not been reviewed

sender_display_name__isstring[]

Filters result to only message groups with the provided sender display name

Filters result to only message groups with the provided sender display name

sender_domain__isstring[]

Filters result to only message groups with the provided sender domain

Filters result to only message groups with the provided sender domain

sender_email__isstring[]

Filters result to only message groups with the provided sender email

Filters result to only message groups with the provided sender email

spam__isstring[]

Filters result to only message groups with the provided spam status

Filters result to only message groups with the provided spam status

subject__isstring[]

Filters result to only message groups with the provided subject

Filters result to only message groups with the provided subject

user_reportedboolean nullable

Filters result to only message groups with at least one reported message

Filters result to only message groups with at least one reported message

vendor_id__isstring[]

Filters result to only message groups with the provided vendor

Filters result to only message groups with the provided vendor

Response

OK

countinteger required

Count of messages groups for this page

stats_limit_exceededboolean

Indicates if 'total' is a lower bound

totalinteger required

Total number of messages groups matching the search