GET: Portfolio Summary

Ingrid

https://api.bitsighttech.com/ratings/v2/portfolio/summaries

Get a summary of your portfolio. This can be used to get a list of the possible values for querying GET: Portfolio Details [/v2/portfolio].

Parameters
Example Request
Example Response
Response Attributes

Parameters

See query parameters for details on the fields (default: all fields) parameter.

folder

[Query] Include only companies in the given folder.

Value: [String] Folder unique identifier [folder_guid]. See GET: Folder Details.

tier

[Query] Include only companies in the given tier.

Value: [String] Tier unique identifier [tier_guid]. See GET: Tiers.

Example Request

curl https://api.bitsighttech.com/ratings/v2/portfolio/summaries -u api_token:

Example Response

{
  "subscription_types":[
    "continuous_monitoring"
  ],
  "industries":[
    "Technology"
  ],
  "types":[
    "CURATED"
  ],
  "countries":[
    "US"
  ],
  "infections":[
    "GigaClicks"
  ],
  "vulnerabilities":[
    "CVE-2016-10712"
  ],
  "open_ports":[
    "AMQP",
    "Port 1010"
  ],
  "software":[
    "WordPress"
  ],
  "providers":[
      "Black Hills Technologies"
  ],
  "products":[
      "Black Hills POS"
  ],
  "product_types":[
    "Order Management"
  ]
}

Response Attributes

Field	Description
subscription_types Array	Available subscription types.
industries Array	The industries of companies in your portfolio.
types Array	How the rating of companies in your portfolio were curated.
countries Array	The locations of companies in your portfolio.
infections Array	Infections that are present in your portfolio.
vulnerabilities Array	Vulnerabilities that are present in your portfolio.
open_ports Array	Ports that are open in your portfolio.
software Array	Software programs used in your portfolio.
providers Array	Service providers that companies in your portfolio rely on.
products Array	Service provider products used in your portfolio.
product_types Array	The types of service provider products used in your portfolio.

September 22, 2020: Published.