Policy Findings
API endpoints for policy findings
View and manage the findings your policies raise.
A finding records that a resource fell short of a policy: a follow-up that was
never exported, a schedule with a gap in cover, a user without the notification
rules their on-call policy requires.
Findings are materialised by a job that runs hourly, so every finding carries a
last_checked_at telling you how fresh it is.
The policy finding object
Example:
"2021-08-17T13:28:57.801578Z"
Unique ID of the finding
Example:
"01G0J1EXE7AXZ2C93K61WBPYEH"
When this finding was last re-evaluated
Example:
"2021-08-17T13:28:57.801578Z"
The policy this finding was raised against
Example:
"01G0J1EXE7AXZ2C93K61WBPYEH"
Type of the policy this finding was raised against
Available options:
debrief, follow_up, on_call_readiness, post_mortem, schedule, shift_conflict, vacation_conflict Example:
"follow_up"
Who is expected to resolve this finding
Show child attributes
Show child attributes
Example:
[ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ]
Where this finding is in its lifecycle
Available options:
pending, active, resolved, cancelled, dismissed Example:
"active"
Example:
"2021-08-17T13:28:57.801578Z"
Days outside the policy's due date
Example:
3
Set when policy_type is debrief.
Show child attributes
Show child attributes
Example:
{ "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Show child attributes
Show child attributes
Example:
{ "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "reason": "This incident is special." }
When this finding becomes overdue
Example:
"2025-10-14T00:00:00.000000Z"
Set when policy_type is follow_up.
Show child attributes
Show child attributes
Example:
{ "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Set when policy_type is on_call_readiness. The user is always the one the finding is about.
Show child attributes
Show child attributes
Example:
{ "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": ["slack"] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": ["slack"] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Set when policy_type is post_mortem.
Show child attributes
Show child attributes
Example:
{ "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Set when policy_type is schedule. Describes a gap in on-call cover.
Show child attributes
Show child attributes
Example:
{ "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }
Set when policy_type is shift_conflict. Someone is on call in two or more places at once.
Show child attributes
Show child attributes
Example:
{ "end_at": "2021-08-17T13:28:57.801578Z", "shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "layer_id": "01FCNDV6P870EA6S7TK1DSYDG0", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" } ], "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Set when policy_type is vacation_conflict. Someone is on call while on holiday.
Show child attributes
Show child attributes
Example:
{ "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }
Was this page helpful?
{
"created_at": "2021-08-17T13:28:57.801578Z",
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"last_checked_at": "2021-08-17T13:28:57.801578Z",
"policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"policy_type": "follow_up",
"responsible_users": [
{
"email": "lisa@incident.io",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Lisa Karlin Curtis",
"role": "owner",
"slack_user_id": "U02AYNF2XJM"
}
],
"state": "active",
"updated_at": "2021-08-17T13:28:57.801578Z",
"days": 3,
"debrief": {
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0"
},
"dismissal": {
"dismissed_at": "2021-08-17T13:28:57.801578Z",
"dismissed_by": {
"alert": {
"id": "01GW2G3V0S59R238FAHPDS1R66",
"title": "*errors.withMessage: PG::Error failed to connect"
},
"api_key": {
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "My test API key"
},
"user": {
"email": "lisa@incident.io",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Lisa Karlin Curtis",
"role": "owner",
"slack_user_id": "U02AYNF2XJM"
},
"workflow": {
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "My little workflow"
}
},
"reason": "This incident is special."
},
"due_at": "2025-10-14T00:00:00.000000Z",
"follow_up": {
"follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0"
},
"on_call_readiness": {
"high_urgency": [
{
"max_delay_seconds": 300,
"met": false,
"method_types": [
"slack"
]
}
],
"low_urgency": [
{
"max_delay_seconds": 300,
"met": false,
"method_types": [
"slack"
]
}
],
"user_id": "01FCNDV6P870EA6S7TK1DSYDG0"
},
"post_mortem": {
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0"
},
"schedule": {
"cause": "nobody_scheduled",
"end_at": "2021-08-17T13:28:57.801578Z",
"has_unscheduled_time": true,
"impacted_users": [
{
"cause": "no_on_call_seat",
"name": "Alice Green",
"user_id": "01FCNDV6P870EA6S7TK1DSYDG0"
}
],
"rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"start_at": "2021-08-17T13:28:57.801578Z"
},
"shift_conflict": {
"end_at": "2021-08-17T13:28:57.801578Z",
"shifts": [
{
"end_at": "2021-08-17T13:28:57.801578Z",
"layer_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"start_at": "2021-08-17T13:28:57.801578Z"
}
],
"start_at": "2021-08-17T13:28:57.801578Z",
"user_id": "01FCNDV6P870EA6S7TK1DSYDG0"
},
"vacation_conflict": {
"end_at": "2021-08-17T13:28:57.801578Z",
"holiday_name": "Joe Bloggs - Holiday",
"rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"start_at": "2021-08-17T13:28:57.801578Z",
"user_id": "01FCNDV6P870EA6S7TK1DSYDG0"
}
}