Get False Positive Rate
Get the share of blocks that were later reversed for a date range, for one organization (slug) or several (slugs). Returns a pooled total, a byOrganization breakdown, and a byAssetType breakdown. Every asset type blocked in the range is returned, including ones with no false positives. The range bounds when the asset was blocked; whether the block still stands is read as of now, so a recent range reads low simply because its reversals have not happened yet.
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 hasblocked, falsePositives and falsePositiveRate
(falsePositives / blocked, from 0 to 1, or null when nothing was blocked).
totalpools every requested organization: all false positives over all blocks, not an average of per-organization rates.byOrganizationhas one entry per requested organization, most blocks first. An organization that blocked nothing in the range is listed withblocked: 0.byAssetTypelists every asset type blocked in the range, including types with no false positives.
Authorizations
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
Organization slug. Optional when authenticating with an org-scoped API key (its own organization is used). Mutually exclusive with slugs.
1Multi-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.
1 - 200 elements1Only include assets blocked on or after this date. A date-only value (YYYY-MM-DD) starts at midnight UTC
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
Only include assets belonging to these brands
x > 0Only include assets scanned from these ISO 3166-1 alpha-2 countries
2Response
Successful response
Pooled across every requested organization: all false positives over all blocks, not an average of per-organization rates
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
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