Risk History

PRO This feature is only available in Enterprise Recon PRO Edition. To find out more about upgrading your ER2 license, please contact Ground Labs Licensing. See Subscription License for more information.

Use this set of APIs to get details on the risk trend, risk history, risk summary and risk breakdown across Targets associated with the Master Server. Data will only be available if the Risk Scoring and Labeling feature has been configured.

For more information, see Dashboard - Sensitive Data Risks, Analysis - Risk Scoring and Labeling, and Risk Scoring and Labeling API.

Risk History Summary (Risk Over Time)

Get a summary of the entire risk history across all Targets and match locations. This summary is an aggregated result of the data points available across all Targets.

Results will be returned in terms of Unix time stamp and number of match locations found for each data point for all locations, locations associated with selected risk levels, and/or unmapped locations (depending on the query string).

The results are sorted according to the Unix time stamp, with the most recent data point displayed first.

Request

Authorization

Basic Authentication

Header Parameters

Query Parameters

Request Samples

Query to retrieve the risk history summary for a specific Target across all match locations with and without associated risk levels.

GET /v1/risk/summary/history?target_id=4759598330602895744
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/history?target_id=4759598330602895744' \
--user apiuser:password123 \
--header "Accept: application/json"

Query to retrieve the risk history summary for unmapped match locations, and the highest priority matching risk profile for high, medium and low risk match locations across all Targets.

GET /v1/risk/summary/history?prioritized=true&all=false
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/history?prioritized=true&all=false' \
--user apiuser:password123 \
--header "Accept: application/json"

Query to retrieve the risk history summary for up to 365 data points for medium risk match locations across all Targets.

GET /v1/risk/summary/history?all=false&high=false&low=false&unmapped=false&offset=0&limit=365
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/history?all=false&high=false&low=false&unmapped=false&offset=0&limit=365' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

Response Samples

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "timestamp": 1523894400,
    "all": "500",
    "high": "1000",
    "medium": "500",
    "low": "250",
    "unmapped": "300"
  },
  ...
  {
    "timestamp": 1523808000,
    "all": "500",
    "high": "1000",
    "medium": "500",
    "low": "250",
    "unmapped": "300"
  }
]

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid value for '{parameter}' query parameter."
}

Risk History Summary by Risk Profile

Get a summary of the entire risk history across all Targets and match locations for a specific risk profile. This summary is an aggregated result of the data points available across all Targets.

Results will be returned in terms of Unix time stamp and number of match locations found for each data point for the specific risk profile.

The results are sorted according to the Unix time stamp, with the most recent data point displayed first.

Request

Authorization

Basic Authentication

Header Parameters

Path Parameters

Query Parameters

Request Samples

Query to retrieve the risk history summary for a specific profile for a specific Target.

GET /v1/risk/summary/history/455572488728221120?target_id=4759598330602895744
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/history/455572488728221120?target_id=4759598330602895744' \
--user apiuser:password123 \
--header "Accept: application/json"

Query to retrieve the risk history summary for up to 365 data points for match locations for which the selected risk profile is the highest priority matching risk profile across all Targets.

GET /v1/risk/summary/history/455572488728221120?prioritized=true&offset=0&limit=365
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/history/455572488728221120?prioritized=true&offset=0&limit=365' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

Response Samples

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: xxx
{
  "message": "Specified 'risk profile' does not exist."
}

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid value for '{parameter}' query parameter."
}

Risk History Summary by Risk Level

Get a summary of the current count of match locations that are (i) mapped to high / medium / low risk levels, and (ii) unmapped locations.

Request

Authorization

Basic Authentication

Header Parameters

Query Parameters

Request Samples

GET /v1/risk/summary/level
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/level' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

Response Samples

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "high": "300",
  "medium": "200",
  "low": "100",
  "unmapped": "400"
}

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid value for '{parameter}' query parameter."
}

Risk History Summary by Target

Get a summary of the current count of match locations that are (i) mapped to high / medium / low risk levels, and (ii) unmapped locations for all Targets on the Master Server.

Request

Authorization

Basic Authentication

Header Parameters

Query Parameters

Request Samples

Query to retrieve the current count of match locations that are mapped to (prioritized) high / medium / low risk levels, and unmapped locations, for the top 10 Targets. Results will be sorted using the default sort order (count of high risk match locations by Target).

GET /v1/risk/summary/targets?prioritized=true&limit=10
Accept: application/json

curl --request GET 'https://er-master:8339/v1/risk/summary/targets?prioritized=true&limit=10' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

Response Samples

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "id": "2486556466149932561",
    "name": "EXAMPLE.COM",
    "high": "1000000",
    "medium": "1000000",
    "low": "7896",
    "unmapped": "300"
  },
  {
    "id": "5776191921548943090",
    "name": "MY-LINUX-SERVER",
    "high": "1000000",
    "medium": "900000",
    "low": "210000",
    "unmapped": "200"
  },
  ...
  {
    "id": "1563630061562709112",
    "name": "GAPPS:EXAMPLEDOMAIN.COM",
    "high": "10000",
    "medium": "10000",
    "low": "10000",
    "unmapped": "500"
  }
]

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid value for '{parameter}' query parameter."
}