https://api.bitsighttech.com/ratings/v1/subscriptions
Each subscription type is returned as its own object with certain fields (quota, name, remaining), followed by an array of JSON objects with their own fields.
Example Request
curl https://api.bitsighttech.com/ratings/v1/subscriptions -u api_token:
Example Response
{ "vendor-selection":{ "companies":[ { "guid":"55555555-aaaa-bbbb-5555-cccccccccccc", "name":"Example Company", "end_date":"2019-12-06", "start_date":"2019-11-06" } ], "quota":1200, "name":"Vendor Selection", "remaining":827 }, "event_forensics":true, […] "user_behavior_forensics":true, […] "real_time_alerts":true, […] }
Field | Description | ||
---|---|---|---|
Subscription Type Object |
The slug name of the subscription type. | ||
companiesArray |
An array of objects containing details of the subscription. | ||
guidString [ entity_guid ] |
The unique identifier of the organization. | ||
nameString |
The name of the organization. | ||
start_dateString [ YYYY‑MM‑DD ] |
The date when the subscription began. | ||
end_dateString [ YYYY‑MM‑DD ] |
The date when a time-limited subscription expires, e.g., Applicants for Insurance organizations. | ||
quotaInteger |
The number of allocations for this subscription. | ||
nameString |
The name of the subscription type. | ||
remainingInteger |
The remaining available subscriptions. | ||
event_forensicsBoolean |
Indicates if this subscription includes the Event Forensics add-on package. | ||
user_behavior_forensicsBoolean |
Indicates if this subscription includes the User Behavior Forensics add-on package. | ||
real_time_alertsBoolean |
Indicates if this subscription includes real-time Infection Alerts. | ||
trial_end_dateString [ YYYY‑MM‑DD ] |
Applicable only for Client/Vendor Access Program recipients, which indicates the final date of Full Access to the Bitsight platform. |
November 18, 2019: Published.
Feedback
0 comments
Please sign in to leave a comment.