Skip to main content
GET
/
v1
/
analytics
/
policies
/
dashboard
One-shot envelope of every policy analytics pipe
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/policies/dashboard \
  --header 'x-api-key: <api-key>'
{
  "violation_rate": [
    {
      "policy_id": "<string>",
      "policy_name": "<string>",
      "strictness": "<string>",
      "evaluations": 123,
      "violations": 123,
      "violation_rate_pct": 123,
      "enforced": 123,
      "would_be": 123,
      "errors": 123,
      "avg_latency_ms": 123
    }
  ],
  "action_breakdown": [
    {
      "action": "<string>",
      "mode_bucket": "<string>",
      "count": 123
    }
  ],
  "violations_timeseries": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "evaluations": 123,
      "violations": 123,
      "enforced_violations": 123,
      "shadow_violations": 123
    }
  ],
  "monitor_rollout": [
    {
      "policy_id": "<string>",
      "policy_name": "<string>",
      "strictness": "<string>",
      "evaluations": 123,
      "would_be_violations": 123,
      "would_be_rate_pct": 123,
      "would_be_blocks": 123,
      "would_be_redacts": 123,
      "would_be_appends": 123,
      "would_be_handoffs": 123,
      "would_be_approvals": 123,
      "errors": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123,
      "response_p95_latency_ms": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

granularity
string
default:hour
Pattern: ^(minute|hour|day|week)$
channel
string | null
start_date
string<date>
required
end_date
string<date>
required

Response

Successful Response

violation_rate
ViolationRateRow · object[]
required
action_breakdown
ActionBreakdownRow · object[]
required
violations_timeseries
ViolationsTimeseriesRow · object[]
required
monitor_rollout
MonitorRolloutRow · object[]
required