- May 24, 2023:
account_guidpath parameter. - March 15, 2022: Instructions for querying multiple values using a single parameter.
- June 25, 2020: Added GUID path parameters and how to get their values.
Use the following parameters to navigate the Bitsight API.
The fields are pre-selected by the object type of the return. Refer to each individual endpoint to get a list of the pre-selected fields for ordering, sorting, and filtering.
Path Parameters
Uses a part of the URL as a parameter.
Path parameters are often unique identifiers (GUID) of a particular data set.
| GUID Type | Description | Values |
|---|---|---|
account_guid |
Your Bitsight account unique identifier. | See GET: User Details [v1] |
alert_guid |
Alerts notify you of changes that occur in your portfolio and changes to risk vector grades. | See GET: Alerts. |
company_request_guid |
Requests to add companies to the Bitsight inventory. | See GET: Company Requests. |
entity_guid |
Companies in the Bitsight inventory, a.k.a. company_guid, provider_guid, & country_guid. |
See GET: Portfolio Details. |
folder_guid |
Folders can be used to organize your portfolio to better understand the security performance of certain groups of companies. | See GET: Folder Details. |
group_guid |
Access Control Groups allow subsets of portfolio companies to be grouped together and users to be assigned access to them. The users will have the ability to see and monitor only the subset of companies. | See GET: Access Control Groups. |
product_guid |
Service provider products include their service offerings, such as web hosting, certificate signing, cloud infrastructure services, email hosting, etc. | See GET: Products of a Company. |
relationship_guid |
Company relationships can be defined to optimize the onboarding workflow by applying the appropriate level of due diligence to a company while they’re being evaluated during onboarding. | See GET: Company Relationship Details. |
template_guid |
Assessment Report templates are used to generate Assessment Reports. | See GET: Assessment Report Template. |
tier_guid |
Tiers are used to prioritize companies in your portfolio based on their criticality to your organization and their security risk. | See GET: Tiers. |
user_guid |
Users of the Bitsight platform. | See GET: Users. |
Query Parameters
Query parameters are used to sort, filter, and limit the response.
Append a question mark (?) to the URL to indicate the start of a query parameter. Additional query parameters are indicated with an ampersand (&), and if present, the URL should be wrapped with double quotes (").
Example:
curl "https://api.example.com/endpoint?field1=value1&field2=value2"
Use comma-separated fields to query multiple values using a single parameter.
Example:
curl "https://api.example.com/endpoint?field1=value1,value2"
| Parameter | Description | Values | |
|---|---|---|---|
cursor |
For select endpoints with large datasets, the cursor parameter is included, which is an opaque base64-encoded string that enables navigation to the next or previous page of results. If a query matches few observations and the response contains a cursor but no data, the cursor can then be used to ask the server to continue searching. |
[String] | |
| Date | For large requests, defining a date range may improve the performance of the API. | [String] | |
start_date |
Set a start date. | [String] The starting date [YYYY‑MM‑DD] for the date range. |
|
end_date |
Set an end date. | [String] The ending date [YYYY‑MM‑DD] for the date range. |
|
fields |
Filter by fields. | [String] Comma-separated field names. Field names are the names of the fields in the response object. The order of the specific fields might not be reflected in the response. | |
format |
Set the format of the response data. | [String]
Example:
|
|
limit |
Set the maximum number of results. The results might include fewer records (even zero), but not more. | [Integer] If not set, the default number of results can vary depending on the endpoint. | |
next_url |
Navigate to the next page of the results. | [String] URL | |
offset |
Set the starting point of the return. | [Integer] A 0 (zero) value starts the results from the first record in the result set. |
|
q |
Perform a full-text search for matching records on all searchable fields. | [String] | |
sort |
Sort the response objects in ascending order (A to Z). | [String] Comma‑separated field names. Field names are the names of the fields in the response object. To sort in descending order, place a minus sign (-) immediately before the field name.
|
|