GET: Bitsight Life Cycle Stages Overview

Ingrid

https://api.bitsighttech.com/ratings/v1/company-life-cycle-types

Get descriptions of all life cycle stages.

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/company-life-cycle-types' -u api_token:

Example Response

{
  "links":{
    "previous":null,
    "next":null
  },
  "count":3,
  "results":[
    {
      "api_name":"onboarding",
      "display_name":"Onboarding",
      "description":"Due diligence process for establishing a new Third Party.",
      "activities":[
        {
          "slug":"adjust_alert_settings",
          "name":"Configure Alerts"
          "description":"Create an alert response process for future monitoring.",
        }
      ],
      "average_duration":90,
      "next_life_cycle_name":"monitoring"
    }
  ]
}

Response Attributes

Field			Description
links Object			Navigation for paginated results.
	previous String		The URL to navigate to the previous page of the results.
	next String		The URL to navigate to the next page of the results.
count Integer			The number of results.
results Array			Life cycle stage details.
	api_name String		The slug name of this stage.
	display_name String		The name of this stage.
	description String		Details of this stage.
	activities Array		Recommended stage actions.
		slug String	The slug name of this action.
		name String	A summary of this action.
		description String	Details of this action.
	average_duration Integer [`days`]		The average duration companies in your portfolio are in this life cycle stage.
	next_life_cycle_name String		The slug name of the next stage.

March 23, 2021: Added average_duration field.
June 25, 2020: Linked to Pagination overview.
May 27, 2020: Published.