https://api.bitsighttech.com/ratings/v1/companies/company_guid/products
Get the enterprise products used at the domains of a particular company.
Parameters
* Required.
See query parameters for details on the following parameters:
fields
limit
(Default: ↻ All)offset
q
sort
Parameter | Values |
---|---|
company_guid * [Path] Identify the company to query. |
[String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
product_guid [Body] Identify the products to query. |
[Array] Product unique identifier [product_guid ]. |
product_types [Body] Identify the product types to query. |
[Array] See product types. |
provider_guid [Body] Identify the providers to query. |
[Array] The unique identifier of the product provider [entity_guid ]. See GET: Portfolio Details. |
provider_name [Body] Identify the providers to query by their names. |
[Array] Product provider's name. |
relative_criticality [Body] Identify the relative criticality to query by. |
[Array] Relative criticality. Values: |
relationship_source [Body] Identify the relationship source to query. |
[Array] See fourth party relationships. |
Example Request
POST command curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/products -H 'Content-Type: application/json' --data-binary '{ "q":"acme" }' --compressed -u api_token:
Example Response
[ { "product_guid":"55555555-pppp-rrrr-oooo-dddddddddddd", "product_name":"Black Hills POS", "product_types":[ "Order Management" ], "provider_guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d", "provider_name":"Black Hills Technologies", "provider_industry":"Technology", "company_count":1, "domain_count":2, "percent_dependent":8.3, "percent_dependent_company":100.0, "relative_importance":0.10714285714285714, "relative_criticality":"high", "relationship_source":"bitsight" } ]
Response Attributes
The server will return an array with the following object:
Field | Description |
---|---|
product_guidString [ product_guid ] |
The unique identifier of the product. |
product_nameString |
The name of the product. |
provider_nameString |
The name of the product provider. |
product_typesArray |
This product’s business functions. See product types. |
provider_guidString [ entity_guid ] |
The unique identifier of the product provider. |
provider_nameString |
The name of the product provider. |
provider_industryString |
The industry of the product provider. |
company_countInteger |
The number of companies that use this product. |
domain_countInteger |
The number of domains that use this product. |
percent_dependentDecimal |
The percentage of assets (domains) in this response that depend on this product. |
percent_dependent_companyDecimal |
The percentage of companies in this response that depend on this product. |
relative_importanceDecimal |
A measurement of this product’s importance. Values: |
relative_criticalityString |
Reiterates the relative_importance field.
Values: |
relationship_sourceString |
How the relationship between this company and the product provider was curated. See fourth party relationships. |
- June 22, 2023: Added additional parameters.
- May 16, 2023: Published.
Feedback
0 comments
Please sign in to leave a comment.