Ocean Security
  1. Metrics
Ocean Security
  • Metrics
    • Get top highlighted threats
      GET
    • Get hours saved metric
      GET
    • Get prevented financial loss metric (USD)
      GET
    • Get protected inboxes count
      GET
    • Get threats over time metric
      GET
    • Get top targeted entities
      GET
    • Get top threat types
      GET
  • Threats
    • List recent threats
      GET
    • Get threat by ID
      GET
    • Get threats by Internet Message ID
      GET
  • Sonar
    • List phishing reports
      GET
    • Get report details by ID
      GET
    • Get aggregated totals by verdict
      GET
    • Get MTTR
      GET
  • Schemas
    • Schemas
      • common.PaginatedResponse
      • common.PaginationParams
      • controllers_metrics.ThreatsOverTimeRow
      • controllers_metrics.TopTargetedEntityRow
      • controllers_metrics.TopThreatTypeRow
      • controllers_metrics.highlightedThreatsResult
      • controllers_metrics.hoursSavedResult
      • controllers_metrics.preventedLossResult
      • controllers_metrics.protectedInboxesResult
      • controllers_metrics.threatsOverTimeResult
      • controllers_metrics.topTargetedEntitiesResult
      • controllers_metrics.topThreatTypesResult
      • controllers_threats.ThreatIndicator
      • controllers_threats.ThreatItem
      • controllers_threats.threatsResult
      • ocean_api_common.BaseResponse-array_controllers_threats_ThreatItem
      • ocean_api_common.BaseResponse-array_ocean_api_controllers_threats_ThreatItem
      • ocean_api_common.BaseResponse-controllers_metrics_highlightedThreatsResult
      • ocean_api_common.BaseResponse-controllers_metrics_hoursSavedResult
      • ocean_api_common.BaseResponse-controllers_metrics_preventedLossResult
      • ocean_api_common.BaseResponse-controllers_metrics_protectedInboxesResult
      • ocean_api_common.BaseResponse-controllers_metrics_topTargetedEntitiesResult
      • ocean_api_common.BaseResponse-controllers_metrics_topThreatTypesResult
      • ocean_api_common.BaseResponse-controllers_threats_ThreatItem
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_highlightedThreatsResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_hoursSavedResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_preventedLossResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_protectedInboxesResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_topTargetedEntitiesResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_metrics_topThreatTypesResult
      • ocean_api_common.BaseResponse-ocean_api_controllers_threats_ThreatItem
      • ocean_api_controllers_metrics.ThreatsOverTimeRow
      • ocean_api_controllers_metrics.TopTargetedEntityRow
      • ocean_api_controllers_metrics.TopThreatTypeRow
      • ocean_api_controllers_metrics.highlightedThreatsResult
      • ocean_api_controllers_metrics.hoursSavedResult
      • ocean_api_controllers_metrics.preventedLossResult
      • ocean_api_controllers_metrics.protectedInboxesResult
      • ocean_api_controllers_metrics.threatsOverTimeResult
      • ocean_api_controllers_metrics.topTargetedEntitiesResult
      • ocean_api_controllers_metrics.topThreatTypesResult
      • ocean_api_controllers_threats.ThreatIndicator
      • ocean_api_controllers_threats.ThreatItem
      • ocean_api_controllers_threats.threatsResult
      • types.ErrorResponse
  1. Metrics

Get top threat types

GET
https://api.ocean.security/api/v1/metrics/top_threat_types
Returns a list of the top 5 threat types and their counts within the specified time period.

Request

Query Params

Header Params

Responses

🟢200OK
application/json
List of top threat types and their counts
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.ocean.security/api/v1/metrics/top_threat_types' \
--header 'X-Api-Key;'
Response Response Example
200 - Example 1
{
    "results": {
        "items": [
            {
                "count_threats": 0,
                "type": "string"
            }
        ]
    },
    "status": 0
}
Modified at 2025-07-27 09:03:30
Previous
Get top targeted entities
Next
List recent threats
Built with