GET /honeytoken/logs

GET 
honeytoken/logs

Get honeytoken logs for the current user

Query Parameters

period_from string Required
example 2021-07-06T00:00:00.000Z

period_to string Required
example 2021-07-06T00:00:00.000Z

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

domain string
Filter honeytoken logs by from_domain substring

to_email string
Filter honeytoken logs by recipient email (to_email) substring

from_email string
Filter honeytoken logs by sender email (from_email) substring

subject string
Filter honeytoken logs by subject substring

trusted string
Filter honeytoken logs by trusted status. Comma-separated or JSON array

Returns

• dataarray
  List of honeytoken log entries for the current user
  • idstring
    Unique identifier of the honeytoken log entry
  • hoststring
    Email provider hostname
  • to_emailstring
    Recipient email address
  • fromstring
    Sender display name
  • from_emailstring
    Sender email address
  • domainstring
    Sender email domain
  • subjectstring
    Email subject
  • inbox_statusstring
    Inbox delivery status
  • ipstring
    Sender IP address
  • sended_timestampstring
    Timestamp when the email was sent
  • received_timestampstring
    Timestamp when the email was received
  • openedboolean
    Whether the email was opened
  • clickedboolean
    Whether a link in the email was clicked
  • trustedboolean
    Whether the sender domain is trusted
• metaobject
  Pagination metadata for list responses
  • countinteger
    Total number of items available
  • offsetinteger
    Number of items skipped
  • limitinteger
    Maximum number of items returned per request

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error