Main Site HUB Security Scorecard API 5.2 Generate a Detailed Report

HUB

5.2 Generate a Detailed Report

Generate a Detailed Report For A Scorecard

SecurityScorecard allows you to generate reports via an API. You can generate the same set of reports that are available from the platform via the API. This API endpoint allows you to generate a detailed report for a scorecard. The Detailed Report is a multi-page PDF with the following information:

  • Introduction to SecurityScorecard
  • Scorecard overview
  • 30-day score history
  • Issues overview (\“Action Items\”)
  • Issue descriptions
  • Issue findings & details

You can check out the full specification for this endpoint here.

Resource URI

/reports/detailed

Parameters:

Name Required Description
Domain Y The primary domain identifying a company in SecurityScorecard.

Sample Code:


    curl -X POST \
        https://api.securityscorecard.io/reports/detailed \
        -H 'Accept: application/json' \
        -H 'Authorization: Token <Your API Key>' \
        -H 'Content-Type: application/json' \
        -H 'cache-control: no-cache' \
        -d '{"domain": "ovofinance.com"}'
        

Sample Response:


{
    "created_at": "2019-08-15T17:52:46.929Z",
    "created_by": "5a9f1cde564fa4662e2b5d03",
    "id": "ae8ae3d6-e8b1-4c84-a65a-8ec14608a98ba",
    "params": {
        "domain": "ovofinance.com",
        "format": "pdf"
    },
    "report_type": "detailed"
}