hornet icon

hornet

Interact with hornet API

Actions452

Email Statistics → Emails Statistics By Time Export Post

AI-generated

Summary

Exports email statistics for a given object within a specified time range, applying optional filters, and returns the API response.

Inputs

  • object_id (required) — The ID of an object (user, customer or partner). Passed as a query parameter.
  • APP-ID (required) — App ID issued by Hornet. Sent in the request header.
  • date_from (required) — Start of the period in ISO‑8601 UTC. Must be earlier than date_to.
  • date_to (required) — End of the period in ISO‑8601 UTC. If set to a future date it is clamped to the current date/time.
  • sort — Sorting criteria for the results.
  • reason — Reason why an email was classified in a specific category.
  • reason_intern — Internal reason for classification.
  • query — Full‑text search within the email.
  • size — Size of the email including attachments.
  • direction — Direction of the email (e.g., inbound, outbound).
  • last_remediation_actions — Actions that can be taken during email processing.
  • header — Text to search for within the email header.
  • body — Text to search for within the email body.
  • comm_partner — Email address of the communication partner.
  • source_hostname — Hostname of the source mail server.
  • destination_hostname — Hostname of the destination mail server.
  • gateway — Hostname of the gateway where the email was processed.
  • source_ip — IP address of the source mail server.
  • destination_ip — IP address of the destination mail server.
  • msg_id — MSG ID of the email.
  • message_id — Message ID of the email.
  • smtp_code — SMTP status code of the email transaction.
  • owner — Email address of the email owner.
  • subject — Subject line of the email.
  • attachments — (Names of) the email attachments.
  • attachment_hash — Hash of each attachment in the email.
  • crypt_type_in — Encryption method used for inbound mail traffic to the gateway.
  • crypt_type_out — Encryption method used for outbound mail traffic from the gateway.
  • status — Delivery status of the email.
  • classification — Category in which the email was classified.
  • regex — Interpret text fields as regular expressions.
  • private — Whether the email is marked as private.

Output shape

Response from the Hornet API containing the exported email statistics (typically a download URL or data payload).

The node uses the Hornet API base URL https://cp.hornetsecurity.com/api/v0. Request options such as batching, SSL verification, proxy, and timeout can be configured via the Request Options section.

Links

Discussion