Retrieve Alert Hits

GET

/alerts/:alertId/hits

GET

/management/alerts/:alertId/hits

1 import requests
2 
3 url = "https://sandbox.api.flagright.com/management/alerts/alertId/hits"
4 
5 headers = {"x-api-key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "hitId": "string",
5       "status": "OPEN",
6       "hitDetails": {
7         "name": "string",
8         "dateOfBirths": [
9           "string"
10         ],
11         "gender": "string",
12         "countries": [
13           "string"
14         ],
15         "documents": [
16           {
17             "id": "string",
18             "name": "string",
19             "formattedId": "string"
20           }
21         ],
22         "addresses": [
23           {
24             "addressType": "string",
25             "addressLine": "string",
26             "city": "string",
27             "country": "AF",
28             "postalCode": "string"
29           }
30         ],
31         "mediaSources": [
32           "string"
33         ]
34       }
35     }
36   ],
37   "hasNext": true,
38   "hasPrev": true,
39   "next": "string",
40   "prev": "string",
41   "count": 1,
42   "pageSize": 1,
43   "last": "string"
44 }

Authentication

x-api-keystring

API Key authentication via header

Path parameters

alertIdstringRequired

Unique Alert Identifier

Query parameters

pageSizedoubleOptional1-100

pagedoubleOptional>=1

Response

itemslist of objects or null

hasNextboolean or null

hasPrevboolean or null

nextstring or null

prevstring or null

countinteger or null

pageSizeinteger or null

laststring or null

Authentication

Path parameters

Query parameters

Response

Errors