Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

GET: User Behavior Statistics

Avatar
Ingrid
Follow
Publication Date – November 11, 2022

⇤ Companies

https://api.bitsighttech.com/ratings/v1/companies/company_guid/user-behavior/statistics

Get User Behavior statistics of a company. The data includes:

  • The number of incidents grouped by file sharing category.
  • The number of affected IP addresses.
  • The number of hashes.

Parameters

*Required.

See query parameters for details on the format (value: json) parameter.

Parameter Description 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 (default) = Exclude event duration.
 
include_patching_cadence
Query		 Determine if Patching Cadence data should be included. [Boolean]
  • true = Include Patching Cadence data.
  • false (default) = Exclude Patching Cadence data.

Example Request

curl -u 'api_token:' 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/user-behavior/statistics'

Example Response

{
  "risk_vectors":{
    "file_sharing":{
      "incidents":108,
      "ips":2,
      "hashes":97,
      "stats":{
        […]
        "OTHER":{
          "incidents":22,
          "ips":2,
          "hashes":20
        }
      }
    }
  }
}

Response Attributes

Field Description 
risk_vectors
Object		 Statistics grouped by risk vector.
  
file_sharing
Object		 File sharing statistics.
  
incidents
Integer		 The number of findings. 
ips
Integer		 The number of IP addresses. 
hashes
Integer		 The number of hashes. 
stats
Object		 Statistics by file sharing category.
  File Sharing Category
Object		 A file sharing category.
  
incidents
Integer		 The number of findings. 
ips
Integer		 The number of IP addresses affected by this file sharing category. 
hashes
Integer		 The number of hashes in this file sharing category.

Related articles