Saltar al contenido principal
POST
Get organization metrics summary

Descripción general

Obtén las métricas de la organización visibles para el cliente y los desgloses de amenazas bloqueadas para un rango de fechas.
El rango de fechas solo se aplica cuando envías ambos campos, startDate y endDate. Si envías solo uno o ninguno, todas las métricas son históricas (sin límite de fechas). Cada métrica filtra según su propia marca de tiempo: los conteos de amenazas (newThreats, domainThreats, …) según cuándo se bloqueó la amenaza, y threatsWatchlisted según cuándo tu organización reportó el asset (activo digital: URL, dirección, perfil, app, etc.).
newThreats cuenta todas las amenazas confirmadas, incluidos los bloqueos pendientes de las organizaciones cuya protección no está activa. Para listar las amenazas que lo componen, usa /detection/list con el filtro blockStatus o /threats/list con includePending. Para listar los assets que componen threatsWatchlisted, usa /organization/watchlist.

Autorizaciones

X-API-KEY
string
header
requerido

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.

Cuerpo

application/json
slug
string
requerido
Minimum string length: 1
startDate
string

Count from this date. A date-only value (YYYY-MM-DD) starts at midnight UTC

endDate
string

Count up to and including this date. A date-only value (YYYY-MM-DD) covers the whole day in UTC; pass a full timestamp for a precise cut-off

brandIds
integer[]
Rango requerido: x > 0

Respuesta

Successful response

metrics
object
requerido
blockedByDay
object[]
requerido
blockedByType
object[]
requerido