Sign in
latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-21173140625.9 KB

616dfa9b3b1f

Findings

Get the finding stats of a company.

Returns the count of active findings grouped by severity (Critical, High, Medium, Low) and status (Failed, Warning, Passed), matching the same data shown by the Findings Heatmap widget in the Black Kite platform. If start_date and end_date are both provided, only findings first discovered within that range are counted; the range can be maximum 365 days apart. If both are omitted, all-time stats are returned. Leaked credential findings are collapsed into a single Failed entry at their highest severity, consistent with the platform UI.

get/api/v2/companies/{id}/findings/stats

Path parameters

idinteger required

The id of the target company.

Query parameters

start_datestring date-time
Example:2024-01-01T00:00:00.000Z

The start date for filtering findings by date range (format: date-time). Must be used together with end_date. The date range must not exceed 365 days.

end_datestring date-time
Example:2024-12-31T23:59:59.000Z

The end date for filtering findings by date range (format: date-time). Must be used together with start_date. The date range must not exceed 365 days.

Response

Success

Critical_Failedinteger

The number of active Critical severity findings with a Failed status.

Critical_Warninginteger

The number of active Critical severity findings with a Warning status.

Critical_Passedinteger

The number of active Critical severity findings with a Passed status.

High_Failedinteger

The number of active High severity findings with a Failed status.

High_Warninginteger

The number of active High severity findings with a Warning status.

High_Passedinteger

The number of active High severity findings with a Passed status.

Medium_Failedinteger

The number of active Medium severity findings with a Failed status.

Medium_Warninginteger

The number of active Medium severity findings with a Warning status.

Medium_Passedinteger

The number of active Medium severity findings with a Passed status.

Low_Failedinteger

The number of active Low severity findings with a Failed status.

Low_Warninginteger

The number of active Low severity findings with a Warning status.

Low_Passedinteger

The number of active Low severity findings with a Passed status.

Example response

{
  "Critical_Failed": 3,
  "Critical_Warning": 1,
  "Critical_Passed": 5,
  "High_Failed": 4,
  "High_Warning": 2,
  "High_Passed": 8,
  "Medium_Failed": 6,
  "Medium_Warning": 3,
  "Medium_Passed": 12,
  "Low_Failed": 2,
  "Low_Warning": 1,
  "Low_Passed": 15
}