hornet icon

hornet

Interact with hornet API

Actions452

Email Statistics → Emails Statistics By Time Post

AI-generated

Summary

Fetch email statistics filtered by object ID and date range from the HornetSecurity API.

Inputs

  • object_id (required) — The ID of an object. An object can be a user, customer or partner.
  • APP-ID (required) — A unique identifier specific to your app issued by us.
  • date_from (required) — The beginning of a date and time period. Represented as ISO-8601 UTC format. Must be earlier than date_to.
  • date_to (required) — The end of a date and time period. Represented as ISO-8601 UTC format. If date_to is in the future, it will be set to the current date and time.
  • sort — Sorting configuration as a JSON object.
  • reason — The reason why an email was classified in a specific category.
  • reason_intern — The internal reason.
  • query — Full text search within the email.
  • size — The size of the email including attachments.
  • direction — The direction of the email.
  • last_remediation_actions — The actions that can be taken during email processing.
  • header — The text to be searched for within the header data.
  • body — The text to be searched for in the email body.
  • comm_partner — The email address of the communication partner.
  • source_hostname — The hostname of the source mailserver.
  • destination_hostname — The hostname of the destination mailserver.
  • gateway — The hostname of the gateway where the email was processed.
  • source_ip — The IP address of the source mailserver.
  • destination_ip — The IP address of the destination mailserver.
  • msg_id — The MSG ID.
  • message_id — The Message ID.
  • smtp_code — The SMTP status code.
  • owner — The email address of the email owner.
  • subject — The subject of the email.
  • attachments — (Names of) the email attachments.
  • attachment_hash — The hash of each attachment in the email.
  • crypt_type_in — The used encryption method for inbound mail traffic to the gate.
  • crypt_type_out — The used encryption method for outbound mail traffic from the gate.
  • status — The delivery status of the email.
  • classification — The category in which the email was classified.
  • regex — Interpret text fields as regular expression.
  • private — Whether the email is marked as private

Output shape

Email statistics data from the HornetSecurity API matching the filter criteria.

All parameters are sent as request body parameters. Required credentials: hornetApi. Base URL: https://cp.hornetsecurity.com/api/v0.

Links

Discussion