Skip to main content
Security Performance Management
Continuous Monitoring
Vendor Risk Management
Cyber Insurance
National Cybersecurity

GET: Statistics

Ingrid

⇤ Companies

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 Values 
company_guid

* [Path] Identify the company to query.

 [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
include_durations

[Query] Determine if event duration should be included.

[Boolean]

  • true = Include event duration.
  • ↻ false = Exclude event duration.
 
include_patching_cadence

[Query] Determine if Patching Cadence data should be included.

[Boolean]

  • true = Include Patching Cadence data.
  • ↻ false = Exclude Patching Cadence data.

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_vectors
Object		 Statistics grouped by risk vector.
  Risk Vector Slug Name
Object		 A risk vector.
  
count
Integer		 The number of events. 
count_period
String		 The period of time. 
average_duration_days
Decimal		 The average event duration in days.

Status Codes

See common errors and status codes.

Code Description
200 – Okay Everything worked as expected.
  • November 11, 2022: Added parameters, response attributes, & status codes.
  • July 11, 2018: Published.

Related articles

Feedback

0 comments

Please sign in to leave a comment.