This endpoint is used to get the overall summary of the account.

Example

📘

periodType value must be one of "WEEK", "MONTH", "QUARTER"

curl --location 'https://api.picussecurity.com/v1/summary/overall' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: {access_token}' \
--data '
{
  "periodType": "QUARTER",
  "simulationIds": [36088, 32631]
}
'
{
    "prevention": {
        "score": 84,
        "threats": {
            "count": 76,
            "blocked": {
                "count": 58,
                "change": 15
            },
            "notBlocked": {
                "count": 18,
                "change": 5
            },
            "notTested": 0
        },
        "objectives": {
            "count": 431,
            "achieved": {
                "count": 68,
                "change": 24
            },
            "notAchieved": {
                "count": 363,
                "change": 182
            },
            "notTested": 0
        }
    },
    "detection": {
        "threatCount": 0,
        "score": 0,
        "loggedThreat": {
            "count": 0,
            "change": 0
        },
        "notLoggedThreat": {
            "count": 0,
            "change": 0
        },
        "alertedThreat": {
            "count": 0,
            "change": 0
        },
        "notAlertedThreat": {
            "count": 0,
            "change": 0
        }
    }
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!