Saltar al contenido principal
POST
Get false positive rate for one or more organizations

Descripción general

Obtén la proporción de bloqueos que luego se revirtieron, para los assets (activos digitales: URL, dirección, perfil, app, etc.) bloqueados en un rango de fechas. Un bloqueo cuenta como falso positivo cuando el asset ya no está bloqueado hoy.

Cuerpo de la solicitud

Cómo leer la respuesta

Cada desglose incluye blocked, falsePositives y falsePositiveRate (falsePositives / blocked, de 0 a 1, o null cuando no se bloqueó nada).
  • total agrupa todas las organizaciones solicitadas: todos los falsos positivos sobre todos los bloqueos, no un promedio de las tasas por organización.
  • byOrganization tiene una entrada por cada organización solicitada, ordenadas de mayor a menor cantidad de bloqueos. Una organización que no bloqueó nada en el rango aparece con blocked: 0.
  • byAssetType lista todos los tipos de asset bloqueados en el rango, incluidos los tipos sin falsos positivos.
Que un bloqueo siga vigente o no se evalúa según el estado actual. Un rango reciente da un valor bajo porque sus reversiones todavía no ocurrieron, así que compara rangos que hayan tenido el mismo tiempo para estabilizarse.

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

Organization slug. Optional when authenticating with an org-scoped API key (its own organization is used). Mutually exclusive with slugs.

Minimum string length: 1
slugs
string[]

Multi-org form. Each slug is auth-checked individually. The response pools every listed organization into total and byAssetType, and breaks it down per organization in byOrganization. Capped at 200 slugs per call. Mutually exclusive with slug.

Required array length: 1 - 200 elements
Minimum string length: 1
startDate
string

Only include assets blocked on or after this date. A date-only value (YYYY-MM-DD) starts at midnight UTC

endDate
string

Only include assets blocked on or before 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[]

Only include assets belonging to these brands

Rango requerido: x > 0
countryCodes
string[]

Only include assets scanned from these ISO 3166-1 alpha-2 countries

Required string length: 2

Respuesta

Successful response

total
object
requerido

Pooled across every requested organization: all false positives over all blocks, not an average of per-organization rates

byOrganization
object[]
requerido

One entry per requested organization, descending by number blocked. An organization that blocked nothing in the range is included with blocked: 0 and a null rate

byAssetType
object[]
requerido

False positive rate, one entry per asset type blocked in the range, descending by number blocked. Asset types with no false positives are included with a rate of 0; asset types with no blocks at all in the range are omitted, since they have no rate to report. The denominator counts block events, not distinct assets, so an asset blocked twice in the range counts twice. Whether a block still stands is read as of now while the range bounds the block itself, so a recent range reads low. An asset's blocked status is global, so a block another organization's report caused to be reversed is counted here too