Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

GET: Peer Group Configuration Details

Avatar
Ingrid
Follow
Publication Date – April 29, 2022

⇤ Peer Analytics

https://api.bitsighttech.com/ratings/v1/peer-analytics/peer-groups

Get peer group configuration details.

Example Request

curl https://api.bitsighttech.com/ratings/v1/peer-analytics/peer-groups -u api_token:

Example Response

{
  "links":{
    "next":null,
    "previous":null
  },
  "count":1,
  "results":[
    {
      "guid":"0b52509d-5066-4eb4-9493-df5460b8f143",
      "name":"Selected",
      "company":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "industries":[
        "mediaentertainment"
      ],
      "sub_industries":[ ],
      "employee_size":"similar",
      "service_size":"any",
      "rating_gte":460,
      "rating_lte":730
    }
  ]
}

Response Attributes

Field Description 
links
Object		 Navigation for multiple pages of results. See pagination.
  
next
String		 The URL for navigating to the next page of the results. 
previous
String		 The URL for navigating to the previous page of the results. 
count
String		 The number of results. 
results
Array		 Peer group configuration details.
  Object A peer group.
  
guid
String [peers_guid]		 The unique identifier of this peer group. 
name
String		 The name of the peer group. 
company
String [entity_guid]		 The unique identifier of the entity selected for comparison. 
industries
Array		 Industries in the peer group. 
sub_industries
Array		 Sub-industries in the peer group. 
employee_size
String		 The employee size for the peer group.
  • similar
  • any
 
service_size
String		 The service size for the peer group.
  • similar
  • any
 
rating_gte
Integer		 The lowest rating within the peer group. 
rating_lte
Integer		 The highest rating within the peer group.

Status Codes

Code Description
200 – Okay Everything worked as expected.
401 – Unauthorized No valid API token was provided.
403 – Permission Denied You do not have permission to access this resource.
404 – Not Found The specified resource does not exist.

Related articles