GET /honeytoken/stats/timeseries

GET 
honeytoken/stats/timeseries

Retrieve timeseries statistics for honeytoken log events

Query Parameters

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

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

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

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

Returns

• dataarray
  • datestring
    Date of the recorded honeytoken hits
  • totalnumber
    Total number of honeytoken hits on this date
  • trustednumber
    Number of hits from trusted senders on this date
  • not_trustednumber
    Number of hits from not trusted senders on this date

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error