GET: Peer Comparison Group Details

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/entity_guid/peer-analytics/peer-group/count

Get information about a peer or benchmark group.

Parameters

* Required.

employee_size

[Query] Filter peers by employee size.

Value: [String]

any
similar

entity_guid

* Required.

[Path] Identify the company to query.

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

industry_slugs

[Query] Filters peers by industry.

Value: [String] Industry slug name. Use GET: Industries with the show_all parameter set to true [/v1/industries?show_all=true].

rating_gte

[Query] Filter peers by a minimum rating.

Value: [Integer] A rating between 300 and 820 as the minimum in the range.

rating_lte

[Query] Filter peers by a maximum rating.

Value: [Integer] A rating between 300 and 820 as the maximum in the range.

service_size

[Query] Filter peers by service size.

Value: [String]

any
similar

sub_industry_slugs

[Query] Filter peers by sub-industry. If set, this overrides the industry parameter.

Value: [String] Sub-industry slug name. Use GET: Industries with the add_sub_industries and show_all parameters set to true [/v1/industries?add_sub_industries=true&show_all=true].

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/peer-analytics/peer-group/count -u api_token:

Example Response

{
  "company_guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
  "peer_group":{
    "industry_slugs":[
      "technology"
    ],
    "employee_count_gte":0,
    "employee_count_lte":0
  },
  "peer_count":76269
}

Response Attributes

Field		Description
company_guid String [`entity_guid`]		The queried company’s unique identifier.
peer_group Object		Peer group information.
	industry_slugs Array	Industries in this peer group.
	employee_count_gte Integer	The lowest number of a peer’s employees.
	employee_count_lte Integer	The highest number of a peer’s employees.
peer_count Integer		The number of peers in this peer group.

Status Codes

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.

December 6, 2023: Benchmark groups now available.
December 5, 2023: How to get industry & sub-industry names.
April 27, 2022: Published.