Main Site HUB Security Scorecard API 5.1 Generating A Summary Report

HUB

5.1 Generating A Summary Report

Generate a Summary 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 summary report for a scorecard. The Summary Report is a 1-page PDF with the following information:

  • Scorecard overview
  • Industry comparison chart
  • Vulnerabilities overview

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

Resource URI

/reports/summary

Parameters:

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

Sample Code:


    curl -X POST \
        https://api.securityscorecard.io/reports/summary \
        -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:48:44.089Z",
    "created_by": "5a9f1cde564fa4662e2b5d03",
    "id": "560963ba-6f9d-4ff4-8399-f4a25bf6c019",
    "params": {
        "domain": "ovofinance.com",
        "format": "pdf"
    },
    "report_type": "summary"
}