- November 11, 2022: Added parameters, response attributes, & status codes.
- July 11, 2018: Published.
https://api.bitsighttech.com/ratings/v1/companies/company_guid/observations/statistics
Get Compromised Systems statistics of a company during the past 1 year. The data includes:
- The number of findings by risk vector.
- The average event duration in days.
Parameters
*Required.
See query parameters for details on the format
(value: json
) parameter.
Parameter | Description | Values |
---|---|---|
company_guidPath |
Identify the company to query. | [String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
include_durationsQuery |
Determine if event duration should be included. | [Boolean]
|
include_patching_cadenceQuery |
Determine if Patching Cadence data should be included. | [Boolean]
|
Example Request
curl -u 'api_token:' 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/observations/statistics'
Example Response
{ "risk_vectors":{ […] "potentially_exploited":{ "count":25, "count_period":"year", "average_duration_days":2.1 } } }
Response Attributes
Field | Description | ||
---|---|---|---|
risk_vectorsObject |
Statistics grouped by risk vector. | ||
Risk Vector Slug Name Object |
A risk vector. | ||
countInteger |
The number of events. | ||
count_periodString |
The period of time. | ||
average_duration_daysDecimal |
The average event duration in days. |
Status Codes
See common errors and status codes.
Code | Description |
---|---|
200 – Okay |
Everything worked as expected. |