Skip to main content
GET
/
v1
/
privacy
/
audit-stats
Aggregate PII scrub stats
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/privacy/audit-stats \
  --header 'x-api-key: <api-key>'
{
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "total_events": 123,
  "total_detections": 123,
  "by_source": {},
  "by_entity_type": [
    {
      "entity_type": "<string>",
      "event_count": 123
    }
  ],
  "trend": [
    {
      "bucket_start": "2023-11-07T05:31:56Z",
      "event_count": 123,
      "detection_count": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
from
string<date-time> | null
​
to
string<date-time> | null
​
bucket
enum<string>
default:day
Available options:
day,
hour

Response

Successful Response

​
period_start
string<date-time>
required
​
period_end
string<date-time>
required
​
total_events
integer
required
​
total_detections
integer
required
​
by_source
By Source · object
required
​
by_entity_type
AuditEntityStat · object[]
required
​
trend
AuditTrendBucket · object[]
required