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:
-
For each Program + User combination: Call
/watchlist_screening/individual/listwith awatchlist_program_idand aclient_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/listwith: * Thewatchlist_screening_idreturned in the/watchlist_screening/individual/listresponse. * The cursor set to the value returned in the next_cursor field of the prior/watchlist_screening/individual/hit/listresponse, 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/listagain with: * The samewatchlist_program_idandclient_user_id. * The cursor set to the value returned in the next_cursor field of the prior/watchlist_screening/individual/listresponse, until you’ve iterated through all screenings for the user. - Repeat with the same
watchlist_program_idand the nextclient_user_id, until you’ve iterated through all users on the program. - Repeat with the next
watchlist_program_id, until you’ve iterated through all your programs.
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.