GET: Portfolio Details [v1] Ingrid https://api.bitsighttech.com/ratings/v1/portfolio Get information about the companies in your portfolio. Version 2 is now available, which includes pagination, improved performance, and enhanced filters. All new functionality is added to the /v2/portfolio endpoint. Parameters See query parameters for details on the following parameters: fields format exclude_alerts_only [Query] Filter out Risk Monitoring subscriptions. Value: [Boolean] true = Exclude Risk Monitoring subscriptions. folder [Query] Show only companies in a specified folder. Value: [String] Folder unique identifier [folder_guid]. See GET: Folder Details. quarters_back [Query] Get ratings from the last day of the # quarter(s) from today. Value: [Integer] rating_date [Query] The latest rating date. Value: [String] YYYY‑MM‑DD show_ips [Query] Include only the organizations with visible IP addresses. Value: [String] show_event_evidence [Query] Include only the organizations with enhanced event evidence. Value: [String] tier [Query] Include only companies that are part of the specified tier(s). Value: [String] Comma-separated tier unique identifiers [tier_guid]. See GET: Tiers. Untiered companies can be included via the untiered alias. Example Request curl https://api.bitsighttech.com/ratings/v1/portfolio -u api_token: Example Response { "my_company":{ "guid":"a940bb61-33c4-42c9-9231-c8194c305db3" }, "companies":[ { "guid":"dddddddd-7777-4444-bbbb-eeeeeeeeeeee", "custom_id":"dddddddd-7777-4444-bbbb-eeeeeeeeeeee", "name":"Example Company, Inc.", "shortname":"EC Inc.", "network_size_v4":0, "rating":780, "rating_date":"2019-10-19", "date_added":"2016-01-14", "industry":"Media/Entertainment", "industry_slug":"mediaentertainment", "sub_industry":"Music", "sub_industry_slug":"music", "type":"CURATED", "logo":"https://api.bitsighttech.com/ratings/v1/companies/dddddddd-7777-4444-bbbb-eeeeeeeeeeee/logo-image", "sparkline":"https://api.bitsighttech.com/ratings/v1/companies/dddddddd-7777-4444-bbbb-eeeeeeeeeeee/sparkline?size=small", "external_id":1710001246, "subscription_type":"Total Risk Monitoring", "subscription_type_key":"continuous_monitoring", "primary_domain":"example.com", "grade_date":null, "display_url":"https://api.bitsighttech.com/app/company/dddddddd-7777-4444-bbbb-eeeeeeeeeeee/overview/" } ], "rating_date":"2019-10-19", "created":"2012-10-31" } Response Attributes Field Description my_company Object If your organization is using Bitsight to monitor itself, this key will appear. guid String [entity_guid] The unique identifier of your organization (My Company). companies Array Contains the monitored companies in your portfolio. Each organization is a separate object. guid String [entity_guid] The unique identifier of this company. custom_id String A custom identifier assigned to this company by your organization. name String The name of this company. shortname String The abbreviated name of this company. network_size_v4 Integer The number of IPv4 addresses attributed to this company. rating Integer This company’s current security rating. rating_date String [YYYY‑MM‑DD] The date when the security rating for this company was last updated. date_added String [YYYY‑MM‑DD] The date when this company was added to the portfolio. industry String This company's industry. industry_slug String The slug name of the industry this company belongs to. sub_industry String This company's sub-industry. sub_industry_slug String The slug name of the sub-industry this company belongs to. type String The rating type. This can have several comma-separated values. logo String The URL path to this company’s logo image, as displayed in the Bitsight platform. sparkline String The URL path to the thumbnail image of this company’s security rating trend line, as shown in the Portfolio page listings. external_id Integer For internal Bitsight use. subscription_type String The type of subscription used to monitor this company. subscription_type_key String The slug name of the subscription type used to monitor this company, for use as a reference with integrations. primary_domain String The domain name of this company’s website. grade_date Null For internal Bitsight use. This value is always null. display_url String The URL path to this company's overview page in the Bitsight platform. rating_date String [YYYY‑MM‑DD] The date when these security ratings were last updated. created String [YYYY‑MM‑DD] The date when your portfolio was created. September 25, 2020: /v2/portfolio now available. Related articles GET: Portfolio Details Portfolio API Endpoint Parameters GET: Portfolio Risk Vector Grades Bitsight Badge Specifications Feedback 0 comments Please sign in to leave a comment.