Skip to main content
POST
Get false positive rate for one or more organizations

Overview

Get the share of blocks that were later reversed, for assets blocked in a date range. A block counts as a false positive when the asset is no longer blocked today.

Request Body

Reading the response

Every breakdown has blocked, falsePositives and falsePositiveRate (falsePositives / blocked, from 0 to 1, or null when nothing was blocked).
  • total pools every requested organization: all false positives over all blocks, not an average of per-organization rates.
  • byOrganization has one entry per requested organization, most blocks first. An organization that blocked nothing in the range is listed with blocked: 0.
  • byAssetType lists every asset type blocked in the range, including types with no false positives.
Whether a block still stands is read as of now. A recent range reads low because its reversals have not happened yet, so compare ranges that have had the same time to settle.

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

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

Required range: x > 0
countryCodes
string[]

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

Required string length: 2

Response

Successful response

total
object
required

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

byOrganization
object[]
required

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[]
required

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