Sign in
Company Trend

Get technical risk trend of a monitored company.

Get technical risk score details of a monitored company for a selectable timeframe and resolution. Defaults to the last year, at monthly resolution, when omitted.

get/api/v2/companies/{id}/trend/technical

Path parameters

idinteger required

The id of the company requested.

Query parameters

timeframe'OneYear' | 'TwoYears'

How far back to look. Defaults to OneYear.

resolution'Monthly' | 'Weekly' | 'Daily'

The bucket granularity of the returned series. Defaults to Monthly. Note: IndustryAverageCyberRating/IndustryAverageGradeLetter are only ever calculated at monthly granularity, so Weekly/Daily resolutions repeat the containing month's industry average value across each bucket.

Response

Success

GradeLetter'A+' | 'A' | 'A-' | 'B+' | 'B' | 'B-' | 'C+' | 'C' | 'C-' | 'D+' | 'D' | 'D-' | 'F' | 'n/a'

Average technical risk score translated into GPA letter grades.

CyberRatingnumber

Average technical risk score. 0 means either this company was not scanned at all or the value is the result of a scan.

IndustryAverageCyberRatingnumber nullable

Average technical risk score for the related industry.

IndustryAverageGradeLetter'A+' | 'A' | 'A-' | 'B+' | 'B' | 'B-' | 'C+' | 'C' | 'C-' | 'D+' | 'D' | 'D-' | 'F' | 'n/a'

Average technical risk score translated into GPA letter grades for the related industry.

BreachIndexnumber float nullable

The Data Breach Index (DBI) is a key performance index that tracks data breaches, measuring their severity based on the number of records compromised and when the data was breached.

RansomwareIndexnumber float nullable

Ransomware Susceptibility Index (RSI) is a metric for customers to understand which of their companies are susceptible to a ransomware attack.

SnapshotDatestring date-time nullable

The start date of the bucket that the values are calculated for: the first day of the month for Monthly resolution, the Monday of the week for Weekly resolution, or the exact day for Daily resolution.

Example response

[
  {
    "GradeLetter": "B+",
    "CyberRating": 87,
    "IndustryAverageCyberRating": 77,
    "IndustryAverageGradeLetter": "B+",
    "BreachIndex": 0.65,
    "RansomwareIndex": 0.322,
    "SnapshotDate": "2021-08-09T08:30:30.682Z"
  }
]

Changes

Changed in 1 of the 3 revisions of this API.2

  • da31d88274df2See the full diff
    • ○

      added the new optional query request parameter resolution

      new-optional-request-parameter

    • ○

      added the new optional query request parameter timeframe

      new-optional-request-parameter