Skip to main content
GET
/
watchlist
/
analytics
/
summary
Screening summary
curl --request GET \
  --url https://api.txcloud.io/v1/watchlist/analytics/summary \
  --header 'Authorization: Bearer <token>'
{
  "period": "<string>",
  "screenings": {
    "total": 123,
    "clear": 123,
    "potential_matches": 123,
    "confirmed_hits": 123
  },
  "hit_rate": 123,
  "false_positive_rate": 123,
  "by_list": {},
  "pending_review": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Summary

period
string
screenings
object
hit_rate
number
false_positive_rate
number
by_list
object
pending_review
integer