Skip to main content
POST
Get organization metrics summary

Overview

Get customer-facing organization metrics and blocked threat breakdowns for a date range.
The date range is only applied when you send both startDate and endDate. With one or neither, every metric is all-time. Each metric filters on its own timestamp: threat counts (newThreats, domainThreats, …) on when the threat was blocked, threatsWatchlisted on when your organization reported the asset.
newThreats counts every confirmed threat, including pending blocks for organizations whose protection is not active. To list the threats behind it, use /detection/list with the blockStatus filter or /threats/list with includePending. To list the assets behind threatsWatchlisted, use /organization/watchlist.

Authorizations

X-API-KEY
string
header
required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json
slug
string
required
Minimum string length: 1
startDate
string
endDate
string
brandIds
integer[]
Required range: x > 0

Response

Successful response

metrics
object
required
blockedByDay
object[]
required
blockedByType
object[]
required