Coverage for fingerprint_server_sdk / api / fingerprint_api.py: 84%

1""" 

2Server API 

3Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. 

4Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. 

5 

6The version of the OpenAPI document: 4 

7Contact: support@fingerprint.com 

8Generated by OpenAPI Generator (https://openapi-generator.tech) 

9 

10Do not edit the class manually. 

11""" # noqa: E501 

12 

13from datetime import date, datetime 

14from typing import Annotated, Any, Optional, Union # noqa: UP035 

15 

16from pydantic import Field, StrictBool, StrictFloat, StrictInt, StrictStr, validate_call 

17 

18from fingerprint_server_sdk.api_client import ApiClient, RequestSerialized 

19from fingerprint_server_sdk.api_response import ApiResponse 

20from fingerprint_server_sdk.configuration import Configuration 

21from fingerprint_server_sdk.models.bot_info_category import BotInfoCategory 

22from fingerprint_server_sdk.models.bot_info_confidence import BotInfoConfidence 

23from fingerprint_server_sdk.models.bot_info_identity import BotInfoIdentity 

24from fingerprint_server_sdk.models.event import Event 

25from fingerprint_server_sdk.models.event_search import EventSearch 

26from fingerprint_server_sdk.models.event_update import EventUpdate 

27from fingerprint_server_sdk.models.search_events_bot import SearchEventsBot 

28from fingerprint_server_sdk.models.search_events_bot_info import SearchEventsBotInfo 

29from fingerprint_server_sdk.models.search_events_end_parameter import SearchEventsEndParameter 

30from fingerprint_server_sdk.models.search_events_incremental_identification_status import ( 

31 SearchEventsIncrementalIdentificationStatus, 

32) 

33from fingerprint_server_sdk.models.search_events_rare_device_percentile_bucket import ( 

34 SearchEventsRareDevicePercentileBucket, 

35) 

36from fingerprint_server_sdk.models.search_events_sdk_platform import SearchEventsSdkPlatform 

37from fingerprint_server_sdk.models.search_events_start_parameter import SearchEventsStartParameter 

38from fingerprint_server_sdk.models.search_events_vpn_confidence import SearchEventsVpnConfidence 

39from fingerprint_server_sdk.rest import RESTResponseType 

40 

41# Type alias for query and form parameter values 

42ParamValue = Union[ 

43 list[BotInfoCategory], 

44 list[BotInfoIdentity], 

45 list[BotInfoConfidence], 

46 str, 

47 int, 

48 float, 

49 bool, 

50 list[str], 

51] 

52 

53 

54class FingerprintApi: 

55 """Fingerprint Python Server SDK 

56 

57 Fingerprint (https://fingerprint.com) is a device intelligence platform offering industry-leading accuracy. Fingerprint Server API allows you to search, update, and delete identification events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. 

58 

59 :param configuration: API client configuration. 

60 """ 

61 

62 def __init__(self, configuration: Configuration) -> None: 

63 self.api_client = ApiClient(configuration) 

64 

65 @validate_call 

66 def delete_visitor_data( 

67 self, 

68 visitor_id: Annotated[ 

69 StrictStr, 

70 Field( 

71 description='The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete.' 

72 ), 

73 ], 

74 _request_timeout: Union[ 

75 None, 

76 Annotated[StrictFloat, Field(gt=0)], 

77 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

78 ] = None, 

79 _request_auth: Optional[dict[StrictStr, Any]] = None, 

80 _content_type: Optional[StrictStr] = None, 

81 _headers: Optional[dict[StrictStr, Any]] = None, 

82 ) -> None: 

83 """Delete a visitor ID 

84 

85 Use this API to request the deletion of all data associated with a specific visitor ID. Upon a request to delete data for a visitor ID, - The data collected from the corresponding browser (or device) will be deleted asynchronously, typically within a few minutes. This data will no longer be available to identify this browser (or device). When the same browser (or device) revisits, it will receive a new visitor ID. - The identification events made from this browser (or device) in the past 10 days are typically deleted within 24 hrs. - The identification events made from this browser (or device) outside of the 10 days will be purged as per your [data retention period](https://docs.fingerprint.com/docs/regions#data-retention). The following timeline illustrates which events are deleted and which remain after a DELETE API request: ``` Day 1: First visit from browser A. (Assigned visitor ID: VID1000) Day 2: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 13: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 14: Delete VID1000 Day 15: Browser A re-visits. (Assigned a different visitor ID: VID9999) Day 15: GET /events/day-13 (Returns 404. The event is within the 10 days of deleting VID1000 and will have been deleted) Day 16: GET /events/day-2 (Returns 200. The event is outside of the 10 days of deleting VID1000 and is still available) ``` ### Availability This API is available only for Enterprise plans **upon request**. If you are interested, please [contact our support team](https://fingerprint.com/support/). ### Rate limits and daily quota The rate limits and daily quota for this API **differ** from those for our other API. The maximum number of DELETE requests that can be made in an hour cannot exceed 30 RPH, and the maximum number that can be made in a day cannot exceed 500 RPD. You can request an increase to these limits by contacting [our support team](https://fingerprint.com/support/). 

86 

87 :param visitor_id: The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete. (required) 

88 :type visitor_id: str 

89 :param _request_timeout: timeout setting for this request. If one 

90 number provided, it will be total request 

91 timeout. It can also be a pair (tuple) of 

92 (connection, read) timeouts. 

93 :type _request_timeout: int, tuple(int, int), optional 

94 :param _request_auth: set to override the auth_settings for an a single 

95 request; this effectively ignores the 

96 authentication in the spec for a single request. 

97 :type _request_auth: dict, optional 

98 :param _content_type: force content-type for the request. 

99 :type _content_type: str, Optional 

100 :param _headers: set to override the headers for a single 

101 request; this effectively ignores the headers 

102 in the spec for a single request. 

103 :type _headers: dict, optional 

104 :return: Returns the result object. 

105 """ # noqa: E501 

106 

107 _param = self._delete_visitor_data_serialize( 

108 visitor_id=visitor_id, 

109 _request_auth=_request_auth, 

110 _content_type=_content_type, 

111 _headers=_headers, 

112 ) 

113 

114 _response_types_map: dict[str, Optional[str]] = { 

115 '200': None, 

116 '400': 'ErrorResponse', 

117 '403': 'ErrorResponse', 

118 '404': 'ErrorResponse', 

119 '429': 'ErrorResponse', 

120 } 

121 

122 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

123 response_data.read() 

124 self.api_client.response_deserialize( 

125 response_data=response_data, 

126 response_types_map=_response_types_map, 

127 ) 

128 

129 @validate_call 

130 def delete_visitor_data_with_http_info( 

131 self, 

132 visitor_id: Annotated[ 

133 StrictStr, 

134 Field( 

135 description='The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete.' 

136 ), 

137 ], 

138 _request_timeout: Union[ 

139 None, 

140 Annotated[StrictFloat, Field(gt=0)], 

141 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

142 ] = None, 

143 _request_auth: Optional[dict[StrictStr, Any]] = None, 

144 _content_type: Optional[StrictStr] = None, 

145 _headers: Optional[dict[StrictStr, Any]] = None, 

146 ) -> ApiResponse[None]: 

147 """Delete a visitor ID 

148 

149 Use this API to request the deletion of all data associated with a specific visitor ID. Upon a request to delete data for a visitor ID, - The data collected from the corresponding browser (or device) will be deleted asynchronously, typically within a few minutes. This data will no longer be available to identify this browser (or device). When the same browser (or device) revisits, it will receive a new visitor ID. - The identification events made from this browser (or device) in the past 10 days are typically deleted within 24 hrs. - The identification events made from this browser (or device) outside of the 10 days will be purged as per your [data retention period](https://docs.fingerprint.com/docs/regions#data-retention). The following timeline illustrates which events are deleted and which remain after a DELETE API request: ``` Day 1: First visit from browser A. (Assigned visitor ID: VID1000) Day 2: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 13: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 14: Delete VID1000 Day 15: Browser A re-visits. (Assigned a different visitor ID: VID9999) Day 15: GET /events/day-13 (Returns 404. The event is within the 10 days of deleting VID1000 and will have been deleted) Day 16: GET /events/day-2 (Returns 200. The event is outside of the 10 days of deleting VID1000 and is still available) ``` ### Availability This API is available only for Enterprise plans **upon request**. If you are interested, please [contact our support team](https://fingerprint.com/support/). ### Rate limits and daily quota The rate limits and daily quota for this API **differ** from those for our other API. The maximum number of DELETE requests that can be made in an hour cannot exceed 30 RPH, and the maximum number that can be made in a day cannot exceed 500 RPD. You can request an increase to these limits by contacting [our support team](https://fingerprint.com/support/). 

150 

151 :param visitor_id: The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete. (required) 

152 :type visitor_id: str 

153 :param _request_timeout: timeout setting for this request. If one 

154 number provided, it will be total request 

155 timeout. It can also be a pair (tuple) of 

156 (connection, read) timeouts. 

157 :type _request_timeout: int, tuple(int, int), optional 

158 :param _request_auth: set to override the auth_settings for an a single 

159 request; this effectively ignores the 

160 authentication in the spec for a single request. 

161 :type _request_auth: dict, optional 

162 :param _content_type: force content-type for the request. 

163 :type _content_type: str, Optional 

164 :param _headers: set to override the headers for a single 

165 request; this effectively ignores the headers 

166 in the spec for a single request. 

167 :type _headers: dict, optional 

168 :return: Returns the result object. 

169 """ # noqa: E501 

170 

171 _param = self._delete_visitor_data_serialize( 

172 visitor_id=visitor_id, 

173 _request_auth=_request_auth, 

174 _content_type=_content_type, 

175 _headers=_headers, 

176 ) 

177 

178 _response_types_map: dict[str, Optional[str]] = { 

179 '200': None, 

180 '400': 'ErrorResponse', 

181 '403': 'ErrorResponse', 

182 '404': 'ErrorResponse', 

183 '429': 'ErrorResponse', 

184 } 

185 

186 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

187 response_data.read() 

188 return self.api_client.response_deserialize( 

189 response_data=response_data, 

190 response_types_map=_response_types_map, 

191 ) 

192 

193 @validate_call 

194 def delete_visitor_data_without_preload_content( 

195 self, 

196 visitor_id: Annotated[ 

197 StrictStr, 

198 Field( 

199 description='The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete.' 

200 ), 

201 ], 

202 _request_timeout: Union[ 

203 None, 

204 Annotated[StrictFloat, Field(gt=0)], 

205 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

206 ] = None, 

207 _request_auth: Optional[dict[StrictStr, Any]] = None, 

208 _content_type: Optional[StrictStr] = None, 

209 _headers: Optional[dict[StrictStr, Any]] = None, 

210 ) -> RESTResponseType: 

211 """Delete a visitor ID 

212 

213 Use this API to request the deletion of all data associated with a specific visitor ID. Upon a request to delete data for a visitor ID, - The data collected from the corresponding browser (or device) will be deleted asynchronously, typically within a few minutes. This data will no longer be available to identify this browser (or device). When the same browser (or device) revisits, it will receive a new visitor ID. - The identification events made from this browser (or device) in the past 10 days are typically deleted within 24 hrs. - The identification events made from this browser (or device) outside of the 10 days will be purged as per your [data retention period](https://docs.fingerprint.com/docs/regions#data-retention). The following timeline illustrates which events are deleted and which remain after a DELETE API request: ``` Day 1: First visit from browser A. (Assigned visitor ID: VID1000) Day 2: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 13: Browser A revisits. (Assigned the same visitor ID: VID1000) Day 14: Delete VID1000 Day 15: Browser A re-visits. (Assigned a different visitor ID: VID9999) Day 15: GET /events/day-13 (Returns 404. The event is within the 10 days of deleting VID1000 and will have been deleted) Day 16: GET /events/day-2 (Returns 200. The event is outside of the 10 days of deleting VID1000 and is still available) ``` ### Availability This API is available only for Enterprise plans **upon request**. If you are interested, please [contact our support team](https://fingerprint.com/support/). ### Rate limits and daily quota The rate limits and daily quota for this API **differ** from those for our other API. The maximum number of DELETE requests that can be made in an hour cannot exceed 30 RPH, and the maximum number that can be made in a day cannot exceed 500 RPD. You can request an increase to these limits by contacting [our support team](https://fingerprint.com/support/). 

214 

215 :param visitor_id: The [visitor ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) you want to delete. (required) 

216 :type visitor_id: str 

217 :param _request_timeout: timeout setting for this request. If one 

218 number provided, it will be total request 

219 timeout. It can also be a pair (tuple) of 

220 (connection, read) timeouts. 

221 :type _request_timeout: int, tuple(int, int), optional 

222 :param _request_auth: set to override the auth_settings for an a single 

223 request; this effectively ignores the 

224 authentication in the spec for a single request. 

225 :type _request_auth: dict, optional 

226 :param _content_type: force content-type for the request. 

227 :type _content_type: str, Optional 

228 :param _headers: set to override the headers for a single 

229 request; this effectively ignores the headers 

230 in the spec for a single request. 

231 :type _headers: dict, optional 

232 :return: Returns the result object. 

233 """ # noqa: E501 

234 

235 _param = self._delete_visitor_data_serialize( 

236 visitor_id=visitor_id, 

237 _request_auth=_request_auth, 

238 _content_type=_content_type, 

239 _headers=_headers, 

240 ) 

241 

242 _response_types_map: dict[str, Optional[str]] = { 

243 '200': None, 

244 '400': 'ErrorResponse', 

245 '403': 'ErrorResponse', 

246 '404': 'ErrorResponse', 

247 '429': 'ErrorResponse', 

248 } 

249 

250 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

251 return response_data.response 

252 

253 def _delete_visitor_data_serialize( 

254 self, 

255 visitor_id: str, 

256 _request_auth: Optional[dict[StrictStr, Any]], 

257 _content_type: Optional[StrictStr], 

258 _headers: Optional[dict[StrictStr, Any]], 

259 ) -> RequestSerialized: 

260 

261 _collection_formats: dict[str, str] = {} 

262 

263 _path_params: dict[str, str] = {} 

264 _query_params: list[tuple[str, ParamValue]] = [] 

265 _header_params: dict[str, Optional[str]] = _headers or {} 

266 _form_params: list[tuple[str, ParamValue]] = [] 

267 _files: dict[ 

268 str, 

269 Union[str, bytes, list[str], list[bytes], tuple[str, bytes], list[tuple[str, bytes]]], 

270 ] = {} 

271 _body_params: Optional[Any] = None 

272 

273 # process the path parameters 

274 if visitor_id is not None: 

275 _path_params['visitor_id'] = visitor_id 

276 

277 # set the HTTP header `Accept` 

278 if 'Accept' not in _header_params: 

279 _header_params['Accept'] = self.api_client.select_header_accept(['application/json']) 

280 

281 # authentication setting 

282 _auth_settings: list[str] = ['bearerAuth'] 

283 

284 return self.api_client.param_serialize( 

285 method='DELETE', 

286 resource_path='/visitors/{visitor_id}', 

287 path_params=_path_params, 

288 query_params=_query_params, 

289 header_params=_header_params, 

290 body=_body_params, 

291 post_params=_form_params, 

292 files=_files, 

293 auth_settings=_auth_settings, 

294 collection_formats=_collection_formats, 

295 _request_auth=_request_auth, 

296 ) 

297 

298 @validate_call 

299 def get_event( 

300 self, 

301 event_id: Annotated[ 

302 StrictStr, 

303 Field( 

304 description='The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place).' 

305 ), 

306 ], 

307 ruleset_id: Annotated[ 

308 Optional[StrictStr], 

309 Field( 

310 description='The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. ' 

311 ), 

312 ] = None, 

313 _request_timeout: Union[ 

314 None, 

315 Annotated[StrictFloat, Field(gt=0)], 

316 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

317 ] = None, 

318 _request_auth: Optional[dict[StrictStr, Any]] = None, 

319 _content_type: Optional[StrictStr] = None, 

320 _headers: Optional[dict[StrictStr, Any]] = None, 

321 ) -> Event: 

322 """Get an event by event ID 

323 

324 Get a detailed analysis of an individual identification event, including Smart Signals. Use `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`. 

325 

326 :param event_id: The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place). (required) 

327 :type event_id: str 

328 :param ruleset_id: The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. 

329 :type ruleset_id: str 

330 :param _request_timeout: timeout setting for this request. If one 

331 number provided, it will be total request 

332 timeout. It can also be a pair (tuple) of 

333 (connection, read) timeouts. 

334 :type _request_timeout: int, tuple(int, int), optional 

335 :param _request_auth: set to override the auth_settings for an a single 

336 request; this effectively ignores the 

337 authentication in the spec for a single request. 

338 :type _request_auth: dict, optional 

339 :param _content_type: force content-type for the request. 

340 :type _content_type: str, Optional 

341 :param _headers: set to override the headers for a single 

342 request; this effectively ignores the headers 

343 in the spec for a single request. 

344 :type _headers: dict, optional 

345 :return: Returns the result object. 

346 """ # noqa: E501 

347 

348 _param = self._get_event_serialize( 

349 event_id=event_id, 

350 ruleset_id=ruleset_id, 

351 _request_auth=_request_auth, 

352 _content_type=_content_type, 

353 _headers=_headers, 

354 ) 

355 

356 _response_types_map: dict[str, Optional[str]] = { 

357 '200': 'Event', 

358 '400': 'ErrorResponse', 

359 '403': 'ErrorResponse', 

360 '404': 'ErrorResponse', 

361 '429': 'ErrorResponse', 

362 '500': 'ErrorResponse', 

363 } 

364 

365 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

366 response_data.read() 

367 return self.api_client.response_deserialize( 

368 response_data=response_data, 

369 response_types_map=_response_types_map, 

370 ).data 

371 

372 @validate_call 

373 def get_event_with_http_info( 

374 self, 

375 event_id: Annotated[ 

376 StrictStr, 

377 Field( 

378 description='The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place).' 

379 ), 

380 ], 

381 ruleset_id: Annotated[ 

382 Optional[StrictStr], 

383 Field( 

384 description='The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. ' 

385 ), 

386 ] = None, 

387 _request_timeout: Union[ 

388 None, 

389 Annotated[StrictFloat, Field(gt=0)], 

390 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

391 ] = None, 

392 _request_auth: Optional[dict[StrictStr, Any]] = None, 

393 _content_type: Optional[StrictStr] = None, 

394 _headers: Optional[dict[StrictStr, Any]] = None, 

395 ) -> ApiResponse[Event]: 

396 """Get an event by event ID 

397 

398 Get a detailed analysis of an individual identification event, including Smart Signals. Use `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`. 

399 

400 :param event_id: The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place). (required) 

401 :type event_id: str 

402 :param ruleset_id: The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. 

403 :type ruleset_id: str 

404 :param _request_timeout: timeout setting for this request. If one 

405 number provided, it will be total request 

406 timeout. It can also be a pair (tuple) of 

407 (connection, read) timeouts. 

408 :type _request_timeout: int, tuple(int, int), optional 

409 :param _request_auth: set to override the auth_settings for an a single 

410 request; this effectively ignores the 

411 authentication in the spec for a single request. 

412 :type _request_auth: dict, optional 

413 :param _content_type: force content-type for the request. 

414 :type _content_type: str, Optional 

415 :param _headers: set to override the headers for a single 

416 request; this effectively ignores the headers 

417 in the spec for a single request. 

418 :type _headers: dict, optional 

419 :return: Returns the result object. 

420 """ # noqa: E501 

421 

422 _param = self._get_event_serialize( 

423 event_id=event_id, 

424 ruleset_id=ruleset_id, 

425 _request_auth=_request_auth, 

426 _content_type=_content_type, 

427 _headers=_headers, 

428 ) 

429 

430 _response_types_map: dict[str, Optional[str]] = { 

431 '200': 'Event', 

432 '400': 'ErrorResponse', 

433 '403': 'ErrorResponse', 

434 '404': 'ErrorResponse', 

435 '429': 'ErrorResponse', 

436 '500': 'ErrorResponse', 

437 } 

438 

439 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

440 response_data.read() 

441 return self.api_client.response_deserialize( 

442 response_data=response_data, 

443 response_types_map=_response_types_map, 

444 ) 

445 

446 @validate_call 

447 def get_event_without_preload_content( 

448 self, 

449 event_id: Annotated[ 

450 StrictStr, 

451 Field( 

452 description='The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place).' 

453 ), 

454 ], 

455 ruleset_id: Annotated[ 

456 Optional[StrictStr], 

457 Field( 

458 description='The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. ' 

459 ), 

460 ] = None, 

461 _request_timeout: Union[ 

462 None, 

463 Annotated[StrictFloat, Field(gt=0)], 

464 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

465 ] = None, 

466 _request_auth: Optional[dict[StrictStr, Any]] = None, 

467 _content_type: Optional[StrictStr] = None, 

468 _headers: Optional[dict[StrictStr, Any]] = None, 

469 ) -> RESTResponseType: 

470 """Get an event by event ID 

471 

472 Get a detailed analysis of an individual identification event, including Smart Signals. Use `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`. 

473 

474 :param event_id: The unique [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id) of each identification request (`requestId` can be used in its place). (required) 

475 :type event_id: str 

476 :param ruleset_id: The ID of the ruleset to evaluate against the event, producing the action to take for this event. The resulting action is returned in the `rule_action` attribute of the response. 

477 :type ruleset_id: str 

478 :param _request_timeout: timeout setting for this request. If one 

479 number provided, it will be total request 

480 timeout. It can also be a pair (tuple) of 

481 (connection, read) timeouts. 

482 :type _request_timeout: int, tuple(int, int), optional 

483 :param _request_auth: set to override the auth_settings for an a single 

484 request; this effectively ignores the 

485 authentication in the spec for a single request. 

486 :type _request_auth: dict, optional 

487 :param _content_type: force content-type for the request. 

488 :type _content_type: str, Optional 

489 :param _headers: set to override the headers for a single 

490 request; this effectively ignores the headers 

491 in the spec for a single request. 

492 :type _headers: dict, optional 

493 :return: Returns the result object. 

494 """ # noqa: E501 

495 

496 _param = self._get_event_serialize( 

497 event_id=event_id, 

498 ruleset_id=ruleset_id, 

499 _request_auth=_request_auth, 

500 _content_type=_content_type, 

501 _headers=_headers, 

502 ) 

503 

504 _response_types_map: dict[str, Optional[str]] = { 

505 '200': 'Event', 

506 '400': 'ErrorResponse', 

507 '403': 'ErrorResponse', 

508 '404': 'ErrorResponse', 

509 '429': 'ErrorResponse', 

510 '500': 'ErrorResponse', 

511 } 

512 

513 response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) 

514 return response_data.response 

515 

516 def _get_event_serialize( 

517 self, 

518 event_id: str, 

519 ruleset_id: Optional[str], 

520 _request_auth: Optional[dict[StrictStr, Any]], 

521 _content_type: Optional[StrictStr], 

522 _headers: Optional[dict[StrictStr, Any]], 

523 ) -> RequestSerialized: 

524 

525 _collection_formats: dict[str, str] = {} 

526 

527 _path_params: dict[str, str] = {} 

528 _query_params: list[tuple[str, ParamValue]] = [] 

529 _header_params: dict[str, Optional[str]] = _headers or {} 

530 _form_params: list[tuple[str, ParamValue]] = [] 

531 _files: dict[ 

532 str, 

533 Union[str, bytes, list[str], list[bytes], tuple[str, bytes], list[tuple[str, bytes]]], 

534 ] = {} 

535 _body_params: Optional[Any] = None 

536 

537 # process the path parameters 

538 if event_id is not None: 

539 _path_params['event_id'] = event_id 

540 

541 # process the query parameters 

542 if ruleset_id is not None: 

543 _query_params.append(('ruleset_id', ruleset_id)) 

544 

545 # set the HTTP header `Accept` 

546 if 'Accept' not in _header_params: 

547 _header_params['Accept'] = self.api_client.select_header_accept(['application/json']) 

548 

549 # authentication setting 

550 _auth_settings: list[str] = ['bearerAuth'] 

551 

552 return self.api_client.param_serialize( 

553 method='GET', 

554 resource_path='/events/{event_id}', 

555 path_params=_path_params, 

556 query_params=_query_params, 

557 header_params=_header_params, 

558 body=_body_params, 

559 post_params=_form_params, 

560 files=_files, 

561 auth_settings=_auth_settings, 

562 collection_formats=_collection_formats, 

563 _request_auth=_request_auth, 

564 ) 

565 

566 @validate_call 

567 def search_events( 

568 self, 

569 limit: Annotated[ 

570 Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], 

571 Field( 

572 description='Maximum number of events to return. Results are selected from the time range (`start`, `end`), ordered by `reverse`, then truncated to provided `limit` size. So `reverse=true` returns the oldest N=`limit` events, otherwise the newest N=`limit` events. ' 

573 ), 

574 ] = None, 

575 pagination_key: Annotated[ 

576 Optional[StrictStr], 

577 Field( 

578 description='Use `pagination_key` to get the next page of results. When more results are available (e.g., you requested up to 100 results for your query using `limit`, but there are more than 100 events total matching your request), the `pagination_key` field is added to the response. The pagination key is an arbitrary string that should not be interpreted in any way and should be passed as-is. In the following request, use that value in the `pagination_key` parameter to get the next page of results: 1. First request, returning most recent 100 events: `GET api-base-url/events?limit=100` 2. Use `response.pagination_key` to get the next page of results: `GET api-base-url/events?limit=100&pagination_key=1740815825085` ' 

579 ), 

580 ] = None, 

581 visitor_id: Annotated[ 

582 Optional[StrictStr], 

583 Field( 

584 description='Unique [visitor identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) issued by Fingerprint Identification and all active Smart Signals. Filter events by matching Visitor ID (`identification.visitor_id` property). ' 

585 ), 

586 ] = None, 

587 high_recall_id: Annotated[ 

588 Optional[StrictStr], 

589 Field( 

590 description='The High Recall ID is a supplementary browser identifier designed for use cases that require wider coverage over precision. Compared to the standard visitor ID, the High Recall ID strives to match incoming browsers more generously (rather than precisely) with existing browsers and thus identifies fewer browsers as new. The High Recall ID is best suited for use cases that are sensitive to browsers being identified as new and where mismatched browsers are not detrimental. Filter events by matching High Recall ID (`supplementary_id_high_recall.visitor_id` property). ' 

591 ), 

592 ] = None, 

593 bot: Annotated[ 

594 Optional[SearchEventsBot], 

595 Field( 

596 description='Filter events by the Bot Detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. > Note: When using this parameter, only events with the `bot` property set to a valid value are returned. Events without a `bot` Smart Signal result are left out of the response. ' 

597 ), 

598 ] = None, 

599 bot_info: Annotated[ 

600 Optional[SearchEventsBotInfo], 

601 Field( 

602 description='Filter events by their Bot Info result, specifically: - `all` - events where any kind of bot was detected. - `none` - events where no bot was detected. ' 

603 ), 

604 ] = None, 

605 bot_info_category: Annotated[ 

606 Optional[list[BotInfoCategory]], 

607 Field( 

608 description='Filter events by their Bot Info Category. Multiple categories can be provided using the repeated keys syntax. For example, `bot_info_category=ai_agent&bot_info_category=ai_assistant`, will match events with a Bot Info Category of `ai_agent` or `ai_assistant`. Other notations like comma-separated or bracket notation are not supported. ' 

609 ), 

610 ] = None, 

611 bot_info_identity: Annotated[ 

612 Optional[list[BotInfoIdentity]], 

613 Field( 

614 description='Filter events by their Bot Info Identity type. Multiple identity types can be provided using the repeated keys syntax. For example, `bot_info_identity=verified&bot_info_identity=signed`, will match events with a Bot Info Identity of `verified` or `signed`. Other notations like comma-separated or bracket notation are not supported. ' 

615 ), 

616 ] = None, 

617 bot_info_confidence: Annotated[ 

618 Optional[list[BotInfoConfidence]], 

619 Field( 

620 description='Filter events by their Bot Info Confidence. Multiple confidences can be provided using the repeated keys syntax. For example, `bot_info_confidence=high&bot_info_confidence=medium`, will match events with a Bot Info Confidence of `high` or `medium`. Other notations like comma-separated or bracket notation are not supported. ' 

621 ), 

622 ] = None, 

623 bot_info_provider: Annotated[ 

624 Optional[list[StrictStr]], 

625 Field( 

626 description='Filter events by their Bot Info Provider. The provider must match exactly, partial or wildcard matching is not supported. Multiple Providers can be provided using the repeated keys syntax. For example, `bot_info_provider=OpenAI&bot_info_provider=AWS`, will match events with a Bot Info Provider of `OpenAI` or `AWS`. Other notations like comma-separated or bracket notation are not supported. ' 

627 ), 

628 ] = None, 

629 bot_info_name: Annotated[ 

630 Optional[list[StrictStr]], 

631 Field( 

632 description='Filter events by their Bot Info Name. The name must match exactly, partial or wildcard matching is not supported. Multiple Names can be provided using the repeated keys syntax. For example, `bot_info_name=ChatGPT%20Agent&bot_info_name=Bedrock%20AgentCore`, will match events with a Bot Info Name of `ChatGPT Agent` or `Bedrock AgentCore`. Other notations like comma-separated or bracket notation are not supported. ' 

633 ), 

634 ] = None, 

635 ip_address: Annotated[ 

636 Optional[StrictStr], 

637 Field( 

638 description='Filter events by IP address or IP range (if CIDR notation is used). If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is assumed. Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32 ' 

639 ), 

640 ] = None, 

641 asn: Annotated[ 

642 Optional[StrictStr], 

643 Field( 

644 description="Filter events by the ASN associated with the event's IP address. This corresponds to the `ip_info.(v4|v6).asn` property in the response. " 

645 ), 

646 ] = None, 

647 linked_id: Annotated[ 

648 Optional[StrictStr], 

649 Field( 

650 description='Filter events by your custom identifier. You can use [linked Ids](https://docs.fingerprint.com/reference/js-agent-v4-get-function#linkedid) to associate identification requests with your own identifier, for example, session Id, purchase Id, or transaction Id. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. ' 

651 ), 

652 ] = None, 

653 url: Annotated[ 

654 Optional[StrictStr], 

655 Field( 

656 description='Filter events by the URL (`url` property) associated with the event. ' 

657 ), 

658 ] = None, 

659 bundle_id: Annotated[ 

660 Optional[StrictStr], 

661 Field(description='Filter events by the Bundle ID (iOS) associated with the event. '), 

662 ] = None, 

663 package_name: Annotated[ 

664 Optional[StrictStr], 

665 Field( 

666 description='Filter events by the Package Name (Android) associated with the event. ' 

667 ), 

668 ] = None, 

669 origin: Annotated[ 

670 Optional[StrictStr], 

671 Field( 

672 description='Filter events by the origin field of the event. This is applicable to web events only (e.g., https://example.com) ' 

673 ), 

674 ] = None, 

675 start: Annotated[ 

676 Optional[SearchEventsStartParameter], 

677 Field( 

678 description="Include events that happened after this point (with timestamp greater than or equal the provided `start` Unix milliseconds value or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does not change `end`'s default of `now` — adjust it separately if needed. ", 

679 ), 

680 ] = None, 

681 end: Annotated[ 

682 Optional[SearchEventsEndParameter], 

683 Field( 

684 description="Include events that happened before this point (with timestamp less than or equal the provided `end` Unix milliseconds value or RFC3339 timestamp). Defaults to now. Setting `end` does not change `start`'s default of `7 days ago` — adjust it separately if needed. ", 

685 ), 

686 ] = None, 

687 reverse: Annotated[ 

688 Optional[StrictBool], 

689 Field( 

690 description='When `true`, sort events oldest first (ascending timestamp order). Defaults to `false` (newest first, descending timestamp order). ' 

691 ), 

692 ] = None, 

693 suspect: Annotated[ 

694 Optional[StrictBool], 

695 Field( 

696 description='Filter events previously tagged as suspicious via the [Update API](https://docs.fingerprint.com/reference/server-api-v4-update-event). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response. ' 

697 ), 

698 ] = None, 

699 vpn: Annotated[ 

700 Optional[StrictBool], 

701 Field( 

702 description='Filter events by VPN Detection result. > Note: When using this parameter, only events with the `vpn` property set to `true` or `false` are returned. Events without a `vpn` Smart Signal result are left out of the response. ' 

703 ), 

704 ] = None, 

705 virtual_machine: Annotated[ 

706 Optional[StrictBool], 

707 Field( 

708 description='Filter events by Virtual Machine Detection result. > Note: When using this parameter, only events with the `virtual_machine` property set to `true` or `false` are returned. Events without a `virtual_machine` Smart Signal result are left out of the response. ' 

709 ), 

710 ] = None, 

711 tampering: Annotated[ 

712 Optional[StrictBool], 

713 Field( 

714 description='Filter events by Browser Tampering Detection result. > Note: When using this parameter, only events with the `tampering.result` property set to `true` or `false` are returned. Events without a `tampering` Smart Signal result are left out of the response. ' 

715 ), 

716 ] = None, 

717 anti_detect_browser: Annotated[ 

718 Optional[StrictBool], 

719 Field( 

720 description='Filter events by Anti-detect Browser Detection result. > Note: When using this parameter, only events with the `tampering.anti_detect_browser` property set to `true` or `false` are returned. Events without a `tampering` Smart Signal result are left out of the response. ' 

721 ), 

722 ] = None, 

723 incognito: Annotated[ 

724 Optional[StrictBool], 

725 Field( 

726 description='Filter events by Browser Incognito Detection result. > Note: When using this parameter, only events with the `incognito` property set to `true` or `false` are returned. Events without an `incognito` Smart Signal result are left out of the response. ' 

727 ), 

728 ] = None, 

729 privacy_settings: Annotated[ 

730 Optional[StrictBool], 

731 Field( 

732 description='Filter events by Privacy Settings Detection result. > Note: When using this parameter, only events with the `privacy_settings` property set to `true` or `false` are returned. Events without a `privacy_settings` Smart Signal result are left out of the response. ' 

733 ), 

734 ] = None, 

735 jailbroken: Annotated[ 

736 Optional[StrictBool], 

737 Field( 

738 description='Filter events by Jailbroken Device Detection result. > Note: When using this parameter, only events with the `jailbroken` property set to `true` or `false` are returned. Events without a `jailbroken` Smart Signal result are left out of the response. ' 

739 ), 

740 ] = None, 

741 frida: Annotated[ 

742 Optional[StrictBool], 

743 Field( 

744 description='Filter events by Frida Detection result. > Note: When using this parameter, only events with the `frida` property set to `true` or `false` are returned. Events without a `frida` Smart Signal result are left out of the response. ' 

745 ), 

746 ] = None, 

747 factory_reset: Annotated[ 

748 Optional[StrictBool], 

749 Field( 

750 description='Filter events by Factory Reset Detection result. > Note: When using this parameter, only events with a `factory_reset` time. Events without a `factory_reset` Smart Signal result are left out of the response. ' 

751 ), 

752 ] = None, 

753 cloned_app: Annotated[ 

754 Optional[StrictBool], 

755 Field( 

756 description='Filter events by Cloned App Detection result. > Note: When using this parameter, only events with the `cloned_app` property set to `true` or `false` are returned. Events without a `cloned_app` Smart Signal result are left out of the response. ' 

757 ), 

758 ] = None, 

759 emulator: Annotated[ 

760 Optional[StrictBool], 

761 Field( 

762 description='Filter events by Android Emulator Detection result. > Note: When using this parameter, only events with the `emulator` property set to `true` or `false` are returned. Events without an `emulator` Smart Signal result are left out of the response. ' 

763 ), 

764 ] = None, 

765 root_apps: Annotated[ 

766 Optional[StrictBool], 

767 Field( 

768 description='Filter events by Rooted Device Detection result. > Note: When using this parameter, only events with the `root_apps` property set to `true` or `false` are returned. Events without a `root_apps` Smart Signal result are left out of the response. ' 

769 ), 

770 ] = None, 

771 vpn_confidence: Annotated[ 

772 Optional[SearchEventsVpnConfidence], 

773 Field( 

774 description='Filter events by VPN Detection result confidence level. `high` - events with high VPN Detection confidence. `medium` - events with medium VPN Detection confidence. `low` - events with low VPN Detection confidence. > Note: When using this parameter, only events with the `vpn.confidence` property set to a valid value are returned. Events without a `vpn` Smart Signal result are left out of the response. ' 

775 ), 

776 ] = None, 

777 min_suspect_score: Annotated[ 

778 Optional[Union[StrictFloat, StrictInt]], 

779 Field( 

780 description='Filter events with Suspect Score result above a provided minimum threshold. > Note: When using this parameter, only events where the `suspect_score` property set to a value exceeding your threshold are returned. Events without a `suspect_score` Smart Signal result are left out of the response. ' 

781 ), 

782 ] = None, 

783 developer_tools: Annotated[ 

784 Optional[StrictBool], 

785 Field( 

786 description='Filter events by Developer Tools detection result. > Note: When using this parameter, only events with the `developer_tools` property set to `true` or `false` are returned. Events without a `developer_tools` Smart Signal result are left out of the response. ' 

787 ), 

788 ] = None, 

789 location_spoofing: Annotated[ 

790 Optional[StrictBool], 

791 Field( 

792 description='Filter events by Location Spoofing detection result. > Note: When using this parameter, only events with the `location_spoofing` property set to `true` or `false` are returned. Events without a `location_spoofing` Smart Signal result are left out of the response. ' 

793 ), 

794 ] = None, 

795 mitm_attack: Annotated[ 

796 Optional[StrictBool], 

797 Field( 

798 description='Filter events by MITM (Man-in-the-Middle) Attack detection result. > Note: When using this parameter, only events with the `mitm_attack` property set to `true` or `false` are returned. Events without a `mitm_attack` Smart Signal result are left out of the response. ' 

799 ), 

800 ] = None, 

801 rare_device: Annotated[ 

802 Optional[StrictBool], 

803 Field( 

804 description='Filter events by Device Rarity detection result. > Note: When using this parameter, only events with the `rare_device` property set to `true` or `false` are returned. Events without a Device Rarity Smart Signal result are left out of the response. > This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). ' 

805 ), 

806 ] = None, 

807 rare_device_percentile_bucket: Annotated[ 

808 Optional[SearchEventsRareDevicePercentileBucket], 

809 Field( 

810 description='Filter events by Device Rarity percentile bucket. `<p95` - device configuration is in the bottom 95% (most common). `p95-p99` - device is in the 95th to 99th percentile. `p99-p99.5` - device is in the 99th to 99.5th percentile. `p99.5-p99.9` - device is in the 99.5th to 99.9th percentile. `p99.9+` - device is in the top 0.1% (rarest). `not_seen` - device configuration has never been observed before. > This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). ' 

811 ), 

812 ] = None, 

813 proxy: Annotated[ 

814 Optional[StrictBool], 

815 Field( 

816 description='Filter events by Proxy detection result. > Note: When using this parameter, only events with the `proxy` property set to `true` or `false` are returned. Events without a `proxy` Smart Signal result are left out of the response. ' 

817 ), 

818 ] = None, 

819 sdk_version: Annotated[ 

820 Optional[StrictStr], 

821 Field( 

822 description='Filter events by a specific SDK version associated with the identification event (`sdk.version` property). Example: `3.11.14` ' 

823 ), 

824 ] = None, 

825 sdk_platform: Annotated[ 

826 Optional[SearchEventsSdkPlatform], 

827 Field( 

828 description='Filter events by the SDK Platform associated with the identification event (`sdk.platform` property) . `js` - Javascript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices. ' 

829 ), 

830 ] = None, 

831 environment: Annotated[ 

832 Optional[list[StrictStr]], 

833 Field( 

834 description='Filter for events by providing one or more environment IDs (`environment_id` property). ### Array syntax To provide multiple environment IDs, use the repeated keys syntax (`environment=env1&environment=env2`). Other notations like comma-separated (`environment=env1,env2`) or bracket notation (`environment[]=env1&environment[]=env2`) are not supported. ' 

835 ), 

836 ] = None, 

837 proximity_id: Annotated[ 

838 Optional[StrictStr], 

839 Field( 

840 description='Filter events by the most precise Proximity ID provided by default. > Note: When using this parameter, only events with the `proximity.id` property matching the provided ID are returned. Events without a `proximity` result are left out of the response. ' 

841 ), 

842 ] = None, 

843 total_hits: Annotated[ 

844 Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], 

845 Field( 

846 description='When set, the response will include a `total_hits` property with a count of total query matches across all pages, up to the specified limit. ' 

847 ), 

848 ] = None, 

849 tor_node: Annotated[ 

850 Optional[StrictBool], 

851 Field( 

852 description='Filter events by Tor Node detection result. > Note: When using this parameter, only events with the `tor_node` property set to `true` or `false` are returned. Events without a `tor_node` detection result are left out of the response. ' 

853 ), 

854 ] = None, 

855 incremental_identification_status: Annotated[ 

856 Optional[SearchEventsIncrementalIdentificationStatus], 

857 Field( 

858 description='Filter events by their incremental identification status (`incremental_identification_status` property). Non incremental identification events are left out of the response. ' 

859 ), 

860 ] = None, 

861 simulator: Annotated[ 

862 Optional[StrictBool], 

863 Field( 

864 description='Filter events by iOS Simulator Detection result. > Note: When using this parameter, only events with the `simulator` property set to `true` or `false` are returned. Events without a `simulator` Smart Signal result are left out of the response. ' 

865 ), 

866 ] = None, 

867 _request_timeout: Union[ 

868 None, 

869 Annotated[StrictFloat, Field(gt=0)], 

870 tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], 

871 ] = None, 

872 _request_auth: Optional[dict[StrictStr, Any]] = None, 

873 _content_type: Optional[StrictStr] = None, 

874 _headers: Optional[dict[StrictStr, Any]] = None, 

875 ) -> EventSearch: 

876 """Search events 

877 

878 ## Search The `/v4/events` endpoint provides a convenient way to search for past events based on specific parameters. Typical use cases and queries include: - Searching for events associated with a single `visitor_id` within a time range to get historical behavior of a visitor. - Searching for events associated with a single `linked_id` within a time range to get all events associated with your internal account identifier. - Excluding all bot traffic from the query (`good` and `bad` bots) By default, the API searches events from the last 7 days, sorts them by newest first and returns the last 10 events. - Use `start` and `end` to specify the time range of the search. - Use `reverse=true` to sort the results oldest first. - Use `limit` to specify the number of events to return. - Use `pagination_key` to get the next page of results if there are more than `limit` events. ### Filtering events with the `suspect` flag The `/v4/events` endpoint unlocks a powerful method for fraud protection analytics. The `suspect` flag is exposed in all events where it was previously set by the update API. You can also apply the `suspect` query parameter as a filter to find all potentially fraudulent activity that you previously marked as `suspect`. This helps identify patterns of fraudulent behavior. ### Environment scoping If you use a secret key that is scoped to an environment, you will only get events associated with the same environment. With a workspace-scoped environment, you will get events from all environments. Smart Signals not activated for your workspace or are not included in the response. 

879 

880 :param limit: Maximum number of events to return. Results are selected from the time range (`start`, `end`), ordered by `reverse`, then truncated to provided `limit` size. So `reverse=true` returns the oldest N=`limit` events, otherwise the newest N=`limit` events. 

881 :type limit: int 

882 :param pagination_key: Use `pagination_key` to get the next page of results. When more results are available (e.g., you requested up to 100 results for your query using `limit`, but there are more than 100 events total matching your request), the `pagination_key` field is added to the response. The pagination key is an arbitrary string that should not be interpreted in any way and should be passed as-is. In the following request, use that value in the `pagination_key` parameter to get the next page of results: 1. First request, returning most recent 100 events: `GET api-base-url/events?limit=100` 2. Use `response.pagination_key` to get the next page of results: `GET api-base-url/events?limit=100&pagination_key=1740815825085` 

883 :type pagination_key: str 

884 :param visitor_id: Unique [visitor identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id) issued by Fingerprint Identification and all active Smart Signals. Filter events by matching Visitor ID (`identification.visitor_id` property). 

885 :type visitor_id: str 

886 :param high_recall_id: The High Recall ID is a supplementary browser identifier designed for use cases that require wider coverage over precision. Compared to the standard visitor ID, the High Recall ID strives to match incoming browsers more generously (rather than precisely) with existing browsers and thus identifies fewer browsers as new. The High Recall ID is best suited for use cases that are sensitive to browsers being identified as new and where mismatched browsers are not detrimental. Filter events by matching High Recall ID (`supplementary_id_high_recall.visitor_id` property). 

887 :type high_recall_id: str 

888 :param bot: Filter events by the Bot Detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. > Note: When using this parameter, only events with the `bot` property set to a valid value are returned. Events without a `bot` Smart Signal result are left out of the response. 

889 :type bot: SearchEventsBot 

890 :param bot_info: Filter events by their Bot Info result, specifically: - `all` - events where any kind of bot was detected. - `none` - events where no bot was detected. 

891 :type bot_info: SearchEventsBotInfo 

892 :param bot_info_category: Filter events by their Bot Info Category. Multiple categories can be provided using the repeated keys syntax. For example, `bot_info_category=ai_agent&bot_info_category=ai_assistant`, will match events with a Bot Info Category of `ai_agent` or `ai_assistant`. Other notations like comma-separated or bracket notation are not supported. 

893 :type bot_info_category: List[BotInfoCategory] 

894 :param bot_info_identity: Filter events by their Bot Info Identity type. Multiple identity types can be provided using the repeated keys syntax. For example, `bot_info_identity=verified&bot_info_identity=signed`, will match events with a Bot Info Identity of `verified` or `signed`. Other notations like comma-separated or bracket notation are not supported. 

895 :type bot_info_identity: List[BotInfoIdentity] 

896 :param bot_info_confidence: Filter events by their Bot Info Confidence. Multiple confidences can be provided using the repeated keys syntax. For example, `bot_info_confidence=high&bot_info_confidence=medium`, will match events with a Bot Info Confidence of `high` or `medium`. Other notations like comma-separated or bracket notation are not supported. 

897 :type bot_info_confidence: List[BotInfoConfidence] 

898 :param bot_info_provider: Filter events by their Bot Info Provider. The provider must match exactly, partial or wildcard matching is not supported. Multiple Providers can be provided using the repeated keys syntax. For example, `bot_info_provider=OpenAI&bot_info_provider=AWS`, will match events with a Bot Info Provider of `OpenAI` or `AWS`. Other notations like comma-separated or bracket notation are not supported. 

899 :type bot_info_provider: List[str] 

900 :param bot_info_name: Filter events by their Bot Info Name. The name must match exactly, partial or wildcard matching is not supported. Multiple Names can be provided using the repeated keys syntax. For example, `bot_info_name=ChatGPT%20Agent&bot_info_name=Bedrock%20AgentCore`, will match events with a Bot Info Name of `ChatGPT Agent` or `Bedrock AgentCore`. Other notations like comma-separated or bracket notation are not supported. 

901 :type bot_info_name: List[str] 

902 :param ip_address: Filter events by IP address or IP range (if CIDR notation is used). If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is assumed. Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32 

903 :type ip_address: str 

904 :param asn: Filter events by the ASN associated with the event's IP address. This corresponds to the `ip_info.(v4|v6).asn` property in the response. 

905 :type asn: str 

906 :param linked_id: Filter events by your custom identifier. You can use [linked Ids](https://docs.fingerprint.com/reference/js-agent-v4-get-function#linkedid) to associate identification requests with your own identifier, for example, session Id, purchase Id, or transaction Id. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. 

907 :type linked_id: str 

908 :param url: Filter events by the URL (`url` property) associated with the event. 

909 :type url: str 

910 :param bundle_id: Filter events by the Bundle ID (iOS) associated with the event. 

911 :type bundle_id: str 

912 :param package_name: Filter events by the Package Name (Android) associated with the event. 

913 :type package_name: str 

914 :param origin: Filter events by the origin field of the event. This is applicable to web events only (e.g., https://example.com) 

915 :type origin: str 

916 :param start: Include events that happened after this point (with timestamp greater than or equal the provided `start` Unix milliseconds value or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does not change `end`'s default of `now` — adjust it separately if needed. 

917 :type start: SearchEventsStartParameter 

918 :param end: Include events that happened before this point (with timestamp less than or equal the provided `end` Unix milliseconds value or RFC3339 timestamp). Defaults to now. Setting `end` does not change `start`'s default of `7 days ago` — adjust it separately if needed.