GET: Peer Comparison Group Configuration Details

Ingrid

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

Get peer and benchmark group 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":2,
  "results":[
    […]
    {
      "guid":"0c9df0eb-cc80-4bca-8284-df4e9d98ecd9",
      "name":"Awesome Inc",
      "description":null,
      "is_shared":false,
      "group_type":"peer_comparison",
      "company":"5e5bcf88-3f72-4b25-a865-4e3d0a278278",
      "industries":[
        "technology"
      ],
      "sub_industries":[ ],
      "employee_size":"any",
      "service_size":"any",
      "rating_gte":300,
      "rating_lte":820,
      "country_codes":[ ],
      "selected_companies":[ ],
      "created_by":{
        "guid":"69696969-5454-abba-9a9a-2121212a121a",
        "name":"Richard Kuga"
      },
      "goal":null,
      "other_goal":null
    }
  ]
}

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 [`peer_guid`]		The unique identifier of this peer group.
		name String		The name of the peer group.
		description String		A description of the group.
		is_shared Boolean		`true` = This is shared with an access control group.
		group_type String		The type of 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. Values: `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.
		country_codes Array		Country codes.
		selected_companies Array		Companies [`entity_guid`] in this group.
		created_by Object		The user who created this group.
			guid String [`user_guid`]	The unique identifier of this user.
			name String	The name of this user.
		goal String		The purpose of this group. Values: `keep_eye_on_subsidiaries` `monitor_competitors` `report_to_stakeholders` `stay_on_top_peer_group` `track_benchmark_risk_vectors` `track_leaderboard_rank` `other`
		other_goal String		If the purpose of the group is other (`"goal":"other"`), this additional string is available to provide context.

Status Codes

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.

December 6, 2023: Benchmark groups now available.
April 29, 2022: Published.