Get top highlighted threats

GET

https://api.ocean.security/api/v1/metrics/highlighted_threats

Retrieves a list of the top 5 highlighted threats within the specified time period.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

A list of top 5 highlighted threats

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.ocean.security/api/v1/metrics/highlighted_threats' \
--header 'X-Api-Key;'

Response Example

200 - Example 1

{
    "results": {
        "items": [
            {
                "id": "string",
                "recipient_email": "string",
                "recipient_name": "string",
                "sender_email": "string",
                "sender_name": "string",
                "source": "string",
                "subject": "string",
                "threat_indicators": [
                    {
                        "indicator_type": "string"
                    }
                ],
                "threat_type": "string",
                "time": "1970-01-01T11:59:59.000Z"
            }
        ]
    },
    "status": 0
}

Modified at 2025-07-27 09:03:30

Get hours saved metric