Page tree

Contents

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get Security Analytics Overview API retrieves your account's health scores: 

  • Overall health score
  • Protection score
  • Detection score
  • Response score 

Sample request

GET https://api.armor.com/security-analytics/overview

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/security-analytics/overviewGET


There are no parameters for this API call. 


Sample return

StatusResponse
200
{
  "timestamp": "2018-04-09T18:56:04.3629984Z",
  "overallScore": 4,
  "protectionScore": 4,
  "detectionScore": 3,
  "responseScore": 5,
  "criticalIncidentsCount": 12,
  "analyzedEventsCount": 1234,
  "vulnerabilities": {
    "scanDate": "0001-01-01T00:00:00",
    "criticalCount": 1,
    "highCount": 2,
    "mediumCount": 3,
    "lowCount": 4,
    "detailsUrl": "url"
  }
}
400
Bad Request



  • No labels

This page has no comments.