How do I report on Monitor screening data?

Via Plaid Dashboard

Plaid offers a built-in reporting solution for Monitor via the Plaid Dashboard, which allows your organization to download a CSV report with the following configurable settings:

Via Plaid API

To report on Monitor screening data across all your users via the Plaid API:

1. For each Program + User combination: Call /watchlist_screening/individual/list with a watchlist_program_id and a client_user_id.
   • Retrieve and store any necessary data (e.g. status, watchlist_screening_id).
   • For each Screening: To retrieve hit-level data, call /watchlist_screening/individual/hit/list with:
   • The watchlist_screening_id returned in the /watchlist_screening/individual/list response.
   • The cursor set to the value returned in the next_cursor field of the prior /watchlist_screening/individual/hit/list response, until you’ve iterated through all cursors (i.e. hits) for the user.
   • To paginate through all screenings for the user, call /watchlist_screening/individual/list again with:
   • The same watchlist_program_id and client_user_id.
   • The cursor set to the value returned in the next_cursor field of the prior /watchlist_screening/individual/list response, until you’ve iterated through all screenings for the user.
2. Repeat with the same watchlist_program_id and the next client_user_id, until you’ve iterated through all users on the program.
3. Repeat with the next watchlist_program_id, until you’ve iterated through all your programs.

If you're also screening entities (businesses) rather than just individuals, follow the same process using the parallel entity endpoints: /watchlist_screening/entity/list and /watchlist_screening/entity/hit/list, which use the same watchlist_program_id and cursor-based pagination pattern.

Any analysis you’d like to run on this (e.g. aggregating data, # of hits across a period of time) will need to be run outside of Plaid, using your own reporting tools.