Skip to main content
Security Performance Management
Continuous Monitoring
Vendor Risk Management
Trust Management Hub
Cyber Insurance
National Cybersecurity

GET: Collaboration Outbox Summary

Ingrid

⇤ Access Requests

https://api.bitsighttech.com/ratings/v1/access-requests/counts

Get a summary of invitations to collaborate via the Client/Vendor Access Program sent by your organization.

Parameters

Parameter Description Values 
company_guid
Query 		Filter by the specified recipient company. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
context.risk_vectors.risk_vector.slug
Query 		Filter by contextual risk vectors. [Array] Comma-separated risk vector slug names. See risk types. 
end_date
Query 		Filter invitations sent prior to the specified date. [String] YYYY-MM-DD 
exclude_requesterid
Query 		Exclude invitations from the specified sender. [String] User unique identifier [user_guid]. See GET: Users. 
folder_guid
Query 		Filter by recipients in the specified folder. [String] Folder unique identifier [folder_guid]. See GET: Folder Details. 
group
Query 		Filter by senders in an Access Control Group. [String] Group unique identifier [group_guid]. See GET: Access Control Groups. 
group_by
Query 		Group the summary by the specified recipient company. [String] Company name. 
reason
Query 		Filter by collaboration reason. [Array] Comma-separated collaboration reasons. 
requesterid
Query 		Filter by the specified sender. [String] User unique identifier [user_guid]. See GET: Users. 
start_date
Query 		Filter invitations sent on and after the specified date. [String] YYYY-MM-DD 
status
Query 		Filter by collaboration status. [Array] Comma-separated collaboration status. 
tier_guid
Query 		Filter by recipients in the specified tier. [String] Tier unique identifier [tier_guid]. See GET: Tiers.

Example Request

curl https://api.bitsighttech.com/ratings/v1/access-requests/counts -u api_token:

Example Response

{
  "total":334,
  "company_count":98,
  "status":{
    "Inactive":0,
    "Active":77,
    "Pending":8,
    "Never":186,
    "Resolved":59
  },
  "invited_eva_portfolio_companies":29,
  "eligible_eva_portfolio_companies":5469
}

Response Attributes

Field Description 
total
Integer 		The number of sent invitations. 
company_count
Integer 		The number of unique recipient companies. 
status
Object 		Collaboration status summary.
  
Inactive
Integer 		This value is always 0 (zero). 
Active
Integer 		The number of recipients who accepted the invitation to collaborate and have access to the Bitsight platform. 
Pending
Integer 		The number of recipients that have not accepted the invitation to collaborate. 
Never
Integer 		The number of recipients that never accepted the invitation. The invitation was sent more than 14 days ago and was never accepted. The activation link is now invalid. 
Resolved
Integer 		The number of resolved collaborations. 
invited_eva_portfolio_companies
Integer 		The number of companies in your portfolio that have been invited to collaborate. 
eligible_eva_portfolio_companies
Integer 		The number of companies in your portfolio that have not been invited to collaborate.
  • June 21, 2021: Added resolved count to status field; The inactive is now always 0 (zero).
  • March 19, 2021: Published.

Related articles

Feedback

0 comments

Please sign in to leave a comment.