hornet icon

hornet

Interact with hornet API

Actions452

Security Awareness Service → Sat Analytics Teachable Moment Group Post

AI-generated

Summary

Posts a request to the Security Awareness Service to get analytics for teachable moment groups (Sat Analytics Teachable Moment Group Post) for a specified customer object.

Inputs

  • object_id (required) — Identifier of the Customer object. Sent as a query parameter.
  • APP-ID (required) — Application ID issued by Hornet Security. Sent as an HTTP header.
  • group_ids — List of SAS group IDs to filter statistics. Sent in the request body as JSON.
  • start_date — Start date for the analytics period. Sent in the request body as a string.
  • end_date — End date for the analytics period. Sent in the request body as a string.
  • requestOptions.batching.batchSize — Number of items per batch for throttling requests; -1 disables batching.
  • requestOptions.batching.batchInterval — Milliseconds between batches; 0 disables interval.
  • requestOptions.allowUnauthorizedCerts — Whether to accept insecure SSL certificates.
  • requestOptions.proxy — HTTP proxy URL (with optional credentials).
  • requestOptions.timeout — Request timeout in milliseconds.

Output shape

JSON

The operation returns the HTTP response from the Hornet API, typically containing analytics results for the requested groups and date range.

Examples

Example 1: Retrieve teachable moment group analytics for customer 12345 for January 2025

Set object_id to 12345, provide APP-ID, set group_ids to [1,2,3], start_date to '2025-01-01', end_date to '2025-01-31'.

Links

Discussion