Get the watchlist screening statistics

get/statistics

Returns the requested watchlist screening statistics.

Request Samples

Response Samples

1{
2 "version": 2,
3 "name": "watchlist screening statistics",
4 "accept": "application/vnd.sas.watchlist.screening.statistics",
5 "count": 2,
6 "start": 0,
7 "limit": 2,
8 "items": [
9 {
10 "collection": "sanctions",
11 "date": "2024-02-14T00:00:00Z",
12 "counters": {
13 "entityScreeningRequests": 3,
14 "paymentScreeningRequests": 0
15 }
16 },
17 {
18 "collection": "sanctions",
19 "date": "2024-02-12T00:00:00Z",
20 "counters": {
21 "entityScreeningRequests": 1,
22 "paymentScreeningRequests": 0
23 }
24 }
25 ],
26 "links": [
27 {
28 "method": "GET",
29 "rel": "up",
30 "href": "/watchlistScreening",
31 "uri": "/watchlistScreening",
32 "type": "application/vnd.sas.api"
33 },
34 {
35 "method": "GET",
36 "rel": "self",
37 "href": "/watchlistScreening/statistics?from=2024-02-12&to=2024-02-14",
38 "uri": "/watchlistScreening/statistics?from=2024-02-12&to=2024-02-14",
39 "type": "application/vnd.sas.collection",
40 "itemType": "application/vnd.sas.watchlist.screening.statistics+json"
41 }
42 ]
43}

Query Parameters

to
string<date>
false

The end date, in YYYY-MM-DD format expressed in UTC (Universal Time Coordinated), of the time frame to use for the data extraction.

from
string<date>
true

The start date, in YYYY-MM-DD format expressed in UTC (Universal Time Coordinated), of the time frame to use for the data extraction.

Header Parameters

Accept
string
false

The desired representation for the response.

Allowed values:
application/vnd.sas.watchlist.screening.statistics+jsonapplication/json
Default:
application/vnd.sas.watchlist.screening.statistics+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

Bad request (the request is not well-formed).

Schema
404Not Found

The service is not available.

Schema
500Internal Server Error

The service encountered an error.

Schema