https://api.bitsighttech.com/ratings/v1/reports
Download either of the following reports:
Parameters
* Required.
Parameter | Values | |
---|---|---|
params * [Body] Identify the company to query. |
[Object] | |
company * [Body] Identify the company to query. |
[String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
|
report_template [Body] Identify the report to download. |
[String] Report unique identifier [
|
|
output * [Query] Identify the location to save the downloaded file, assign a name, and type of file. |
[String] The path in your directory. |
Example Request
cURL Example
curl -X POST https://api.bitsighttech.com/ratings/v1/reports -u api_token: -H "Content-Type: application/json" -d '{"params": {"company": "a940bb61-33c4-42c9-9231-c8194c305db3"},"report_template": "d1100906-2653-4d80-8cb2-c95b3cf87546"}' --output downloads/filename.pdf
JSON Example
{ "params": { "company": "a940bb61-33c4-42c9-9231-c8194c305db3" }, "report_template": "d1100906-2653-4d80-8cb2-c95b3cf87546" }
Example Response
The download status is displayed. If successful, the file is downloaded to the identified folder in your directory.
- May 24, 2024: Parameter for specifying a report.
- February 26, 2020: Published.
Feedback
0 comments
Please sign in to leave a comment.