Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

GET: Recommended Peers

Avatar
Ingrid
Follow
Publication Date – April 27, 2022

⇤ Companies

https://api.bitsighttech.com/v1/companies/entity_guid/peer-analytics/recommended-peers

Get peer recommendations.

Parameters

*Required.

Parameter Description Values 
entity_guid
Path		 Identify the company to query. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
include
Query		 Include breaches_past_year in the response. [String] breaches_past_year

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9/peer-analytics/recommended-peers -u api_token:

Example Response

[
  […]
  {
    "guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
    "name":"Actors Films",
    "logo":"https://api.bitsighttech.com/ratings/v1/companies/1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9/logo-image",
    "industry_name":"Media/Entertainment",
    "sub_industry_name":"Motion Pictures and Film",
    "is_subscribed":true
  }
]

Response Attributes

Field Description 
guid
String [entity_guid]		 The unique identifier of this company. 
name
String		 The name of this company. 
logo
String		 The Bitsight platform URL where this company’s logo is stored. 
industry_name
String		 The industry of this company. 
sub_industry_name
String		 The sub-industry of this company. 
is_subscribed
Boolean		 true = You’re subscribed to this company.

Status Codes

Code Description
200 – Okay Everything worked as expected.
400 – Bad Data This can often be due to missing a required parameter.
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