hornet icon

hornet

Interact with hornet API

Actions452

Security Awareness Service → Sat Phishing Employee Evaluation Summary Get

AI-generated

Summary

Retrieves the SAT phishing employee evaluation summary for a given object, optionally filtered by mailbox ID.

Inputs

  • object_id — The ID of an object (user, customer, or partner). Sent as a query parameter. Defaults to 0 if not provided.
  • mailbox_id — ID of a mailbox. Used as a preferred selector when supplied together with object_id. Sent as a query parameter. Defaults to 0 if not provided.
  • APP-ID (required) — Application identifier issued by the service. Sent as a request header. Must be provided.

Output shape

object

Returns the SAT phishing employee evaluation summary for the specified object (and mailbox, if given). The exact shape depends on the API response but contains the evaluation data.

Examples

Example 1: Get evaluation summary for a user with object ID 12345.

Set object_id to 12345, leave mailbox_id at default, provide APP-ID header.

Example 2: Get evaluation summary for a specific mailbox within a partner.

Set object_id to the partner ID, mailbox_id to the desired mailbox ID, provide APP-ID header.

Links

Discussion