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

POST: Download Report

Ingrid

https://api.bitsighttech.com/ratings/v1/reports

Download either of the following reports:

Parameters

* Required.

params

* Required.

[Body] Identify the company to query.

Value: [Object]

company

* Required for the Company Overview report.

[Body] Identify the company to generate a Company Overview report.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

guid

* Required for an Executive report.

[Body] Identify the company to generate an Executive report.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

report_template

[Body] Identify the report to download.

Value: [String] Report unique identifier [report_guid].

  • ↻ Company Overview (default)
  • Executive = d1100906-2653-4d80-8cb2-c95b3cf87546
output

* Required.

[Query] Identify the location to save the downloaded file, assign a name, and type of file.

Value: [String] The path in your directory.

Example Company Overview 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"}"}' --output downloads/filename.pdf

JSON Example

{
  "params": {
    "company": "a940bb61-33c4-42c9-9231-c8194c305db3"
  }
}

Example Executive Request

cURL Example

curl -X POST https://api.bitsighttech.com/ratings/v1/reports -u api_token: -H "Content-Type: application/json" -d '{"params": {"guid": "a940bb61-33c4-42c9-9231-c8194c305db3"},"report_template": "d1100906-2653-4d80-8cb2-c95b3cf87546"}' --output downloads/filename.pdf

JSON Example

{
  "params": {
    "guid": "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.

  • December 20, 2024: company parameter for the overview report and guid parameter for the executive report.
  • May 24, 2024: Parameter for specifying a report.
  • February 26, 2020: Published.

Related articles

Feedback

3 comments

Date Votes
  • Jeffery Malson

    I can't get the default Company Overview report to download.  If I omit the report template I get Detail: Not found.   Any suggestions on how I can get it to work?

    0
  • Ingrid

    Detail: Not found is the same as the 404 Not found status code, which means “The specified resource could not be found.” If you're using cURL, have you included the required entity_guid parameter and identified where to download the file with --output {The path in your directory}?

    0
  • Allen Shymchuk

    Using cURL in CMD.exe/Windows, the example provided for Company Overview does not appear to work… on the assumption that we are using a valid API key, and company_guid… we get the following response from CMD or Powershell if we use -d “company=GUID”…

    In both cases, the downloaded file is 1KB, and contains the following…

    {"detail":"JSON parse error - Expecting value: line 1 column 1 (char 0)"}

    In PowerShell, we created our own BitSightAPI Module for various methods, and get 404.

    0

Please sign in to leave a comment.