Main Site HUB Security Scorecard API 8.1 Get all the notifications from the last 7 days

HUB

8.1 Get all the notifications from the last 7 days

Get all the notifications from the last 7 days

This API endpoint allows you to get all the notifications the alerts you have configured have generated in the past 7 days. You can check out the full specification for this endpoint here

Resource URI

/users/by-username/{username}/notifications/recent?portfolio={portfolio}

Parameters:

Name Required Description
Username Y The username of a user (ex: [email protected])
Portfolio ID Y The ID of a portfolio. Use this parameter to filter out notifications for specific portfolios

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/users/by-username/[email protected]/notifications/recent?portfolio=4be6fb79e4b03c6244a26d41 \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "entries": [
        {
            "alert_settings": [
                "a53d8090-8b95-11e9-9888-af96bfb808eb"
            ],
            "change_data": [
                {
                    "direction": "rises",
                    "factor": "overall",
                    "grade_letter": "C",
                    "score": 70,
                    "score_impact": 1
                }
            ],
            "change_type": "score_change",
            "company_name": "OvoFinance LLC",
            "created_at": "2019-08-16T12:43:39.114Z",
            "domain": "ovofinance.com",
            "id": "c66bcb54-074c-5ea2-b61a-93eadf35c1ee",
            "my_scorecard": false,
            "portfolios": [
                {
                    "id": "5be6fb72e4b07c6244a26d41",
                    "name": "Critical Vendor"
                }
            ],
            "username": "[email protected]"
        },
        {
            "alert_settings": [
                "a53d8090-8b95-11e9-9888-af96bfb808eb"
            ],
            "change_data": [
                {
                    "direction": "rises",
                    "factor": "overall",
                    "grade_letter": "B",
                    "score": 80,
                    "score_impact": 3
                }
            ],
            "change_type": "score_change",
            "company_name": "Acme Corp.",
            "created_at": "2019-08-16T12:43:39.090Z",
            "domain": "acmecorp.com",
            "id": "58f0467f-c9ec-534d-ad4e-0f057af5fd87",
            "my_scorecard": false,
            "portfolios": [
                {
                    "id": "5be6fb72e4b07c6244a26d41",
                    "name": "Critical Vendor"
                }
            ],
            "username": "[email protected]"
        }
    ],
    "page": 0,
    "size": 2
}