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 typing import Annotated, Any, Optional, Union # noqa: UP035 

14 

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

16 

17from fingerprint_server_sdk.api_client import ApiClient, RequestSerialized 

18from fingerprint_server_sdk.api_response import ApiResponse 

19from fingerprint_server_sdk.configuration import Configuration 

20from fingerprint_server_sdk.models.event import Event 

21from fingerprint_server_sdk.models.event_search import EventSearch 

22from fingerprint_server_sdk.models.event_update import EventUpdate 

23from fingerprint_server_sdk.models.search_events_bot import SearchEventsBot 

24from fingerprint_server_sdk.models.search_events_incremental_identification_status import ( 

25 SearchEventsIncrementalIdentificationStatus, 

26) 

27from fingerprint_server_sdk.models.search_events_rare_device_percentile_bucket import ( 

28 SearchEventsRareDevicePercentileBucket, 

29) 

30from fingerprint_server_sdk.models.search_events_sdk_platform import SearchEventsSdkPlatform 

31from fingerprint_server_sdk.models.search_events_vpn_confidence import SearchEventsVpnConfidence 

32from fingerprint_server_sdk.rest import RESTResponseType 

33 

34# Type alias for query and form parameter values 

35ParamValue = Union[str, int, float, bool, list[str]] 

36 

37 

38class FingerprintApi: 

39 """Fingerprint Python Server SDK 

40 

41 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. 

42 

43 :param configuration: API client configuration. 

44 """ 

45 

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

47 self.api_client = ApiClient(configuration) 

48 

49 @validate_call 

50 def delete_visitor_data( 

51 self, 

52 visitor_id: Annotated[ 

53 StrictStr, 

54 Field( 

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

56 ), 

57 ], 

58 _request_timeout: Union[ 

59 None, 

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

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

62 ] = None, 

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

64 _content_type: Optional[StrictStr] = None, 

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

66 ) -> None: 

67 """Delete data by visitor ID 

68 

69 Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Workspace](https://docs.fingerprint.com/docs/glossary#fingerprint-workspace). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://docs.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/v4/events` API](https://docs.fingerprint.com/reference/server-api-v4-get-event) with an `event_id` that was made outside of the 10 days, you will still receive a valid response. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. 

70 

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

72 :type visitor_id: str 

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

74 number provided, it will be total request 

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

76 (connection, read) timeouts. 

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

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

79 request; this effectively ignores the 

80 authentication in the spec for a single request. 

81 :type _request_auth: dict, optional 

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

83 :type _content_type: str, Optional 

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

85 request; this effectively ignores the headers 

86 in the spec for a single request. 

87 :type _headers: dict, optional 

88 :return: Returns the result object. 

89 """ # noqa: E501 

90 

91 _param = self._delete_visitor_data_serialize( 

92 visitor_id=visitor_id, 

93 _request_auth=_request_auth, 

94 _content_type=_content_type, 

95 _headers=_headers, 

96 ) 

97 

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

99 '200': None, 

100 '400': 'ErrorResponse', 

101 '403': 'ErrorResponse', 

102 '404': 'ErrorResponse', 

103 '429': 'ErrorResponse', 

104 } 

105 

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

107 response_data.read() 

108 self.api_client.response_deserialize( 

109 response_data=response_data, 

110 response_types_map=_response_types_map, 

111 ) 

112 

113 @validate_call 

114 def delete_visitor_data_with_http_info( 

115 self, 

116 visitor_id: Annotated[ 

117 StrictStr, 

118 Field( 

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

120 ), 

121 ], 

122 _request_timeout: Union[ 

123 None, 

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

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

126 ] = None, 

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

128 _content_type: Optional[StrictStr] = None, 

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

130 ) -> ApiResponse[None]: 

131 """Delete data by visitor ID 

132 

133 Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Workspace](https://docs.fingerprint.com/docs/glossary#fingerprint-workspace). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://docs.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/v4/events` API](https://docs.fingerprint.com/reference/server-api-v4-get-event) with an `event_id` that was made outside of the 10 days, you will still receive a valid response. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. 

134 

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

136 :type visitor_id: str 

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

138 number provided, it will be total request 

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

140 (connection, read) timeouts. 

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

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

143 request; this effectively ignores the 

144 authentication in the spec for a single request. 

145 :type _request_auth: dict, optional 

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

147 :type _content_type: str, Optional 

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

149 request; this effectively ignores the headers 

150 in the spec for a single request. 

151 :type _headers: dict, optional 

152 :return: Returns the result object. 

153 """ # noqa: E501 

154 

155 _param = self._delete_visitor_data_serialize( 

156 visitor_id=visitor_id, 

157 _request_auth=_request_auth, 

158 _content_type=_content_type, 

159 _headers=_headers, 

160 ) 

161 

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

163 '200': None, 

164 '400': 'ErrorResponse', 

165 '403': 'ErrorResponse', 

166 '404': 'ErrorResponse', 

167 '429': 'ErrorResponse', 

168 } 

169 

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

171 response_data.read() 

172 return self.api_client.response_deserialize( 

173 response_data=response_data, 

174 response_types_map=_response_types_map, 

175 ) 

176 

177 @validate_call 

178 def delete_visitor_data_without_preload_content( 

179 self, 

180 visitor_id: Annotated[ 

181 StrictStr, 

182 Field( 

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

184 ), 

185 ], 

186 _request_timeout: Union[ 

187 None, 

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

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

190 ] = None, 

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

192 _content_type: Optional[StrictStr] = None, 

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

194 ) -> RESTResponseType: 

195 """Delete data by visitor ID 

196 

197 Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Workspace](https://docs.fingerprint.com/docs/glossary#fingerprint-workspace). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://docs.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/v4/events` API](https://docs.fingerprint.com/reference/server-api-v4-get-event) with an `event_id` that was made outside of the 10 days, you will still receive a valid response. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. 

198 

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

200 :type visitor_id: str 

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

202 number provided, it will be total request 

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

204 (connection, read) timeouts. 

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

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

207 request; this effectively ignores the 

208 authentication in the spec for a single request. 

209 :type _request_auth: dict, optional 

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

211 :type _content_type: str, Optional 

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

213 request; this effectively ignores the headers 

214 in the spec for a single request. 

215 :type _headers: dict, optional 

216 :return: Returns the result object. 

217 """ # noqa: E501 

218 

219 _param = self._delete_visitor_data_serialize( 

220 visitor_id=visitor_id, 

221 _request_auth=_request_auth, 

222 _content_type=_content_type, 

223 _headers=_headers, 

224 ) 

225 

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

227 '200': None, 

228 '400': 'ErrorResponse', 

229 '403': 'ErrorResponse', 

230 '404': 'ErrorResponse', 

231 '429': 'ErrorResponse', 

232 } 

233 

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

235 return response_data.response 

236 

237 def _delete_visitor_data_serialize( 

238 self, 

239 visitor_id: str, 

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

241 _content_type: Optional[StrictStr], 

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

243 ) -> RequestSerialized: 

244 

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

246 

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

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

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

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

251 _files: dict[ 

252 str, 

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

254 ] = {} 

255 _body_params: Optional[Any] = None 

256 

257 # process the path parameters 

258 if visitor_id is not None: 

259 _path_params['visitor_id'] = visitor_id 

260 

261 # set the HTTP header `Accept` 

262 if 'Accept' not in _header_params: 

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

264 

265 # authentication setting 

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

267 

268 return self.api_client.param_serialize( 

269 method='DELETE', 

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

271 path_params=_path_params, 

272 query_params=_query_params, 

273 header_params=_header_params, 

274 body=_body_params, 

275 post_params=_form_params, 

276 files=_files, 

277 auth_settings=_auth_settings, 

278 collection_formats=_collection_formats, 

279 _request_auth=_request_auth, 

280 ) 

281 

282 @validate_call 

283 def get_event( 

284 self, 

285 event_id: Annotated[ 

286 StrictStr, 

287 Field( 

288 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).' 

289 ), 

290 ], 

291 ruleset_id: Annotated[ 

292 Optional[StrictStr], 

293 Field( 

294 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. ' 

295 ), 

296 ] = None, 

297 _request_timeout: Union[ 

298 None, 

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

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

301 ] = None, 

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

303 _content_type: Optional[StrictStr] = None, 

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

305 ) -> Event: 

306 """Get an event by event ID 

307 

308 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`. 

309 

310 :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) 

311 :type event_id: str 

312 :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. 

313 :type ruleset_id: str 

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

315 number provided, it will be total request 

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

317 (connection, read) timeouts. 

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

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

320 request; this effectively ignores the 

321 authentication in the spec for a single request. 

322 :type _request_auth: dict, optional 

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

324 :type _content_type: str, Optional 

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

326 request; this effectively ignores the headers 

327 in the spec for a single request. 

328 :type _headers: dict, optional 

329 :return: Returns the result object. 

330 """ # noqa: E501 

331 

332 _param = self._get_event_serialize( 

333 event_id=event_id, 

334 ruleset_id=ruleset_id, 

335 _request_auth=_request_auth, 

336 _content_type=_content_type, 

337 _headers=_headers, 

338 ) 

339 

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

341 '200': 'Event', 

342 '400': 'ErrorResponse', 

343 '403': 'ErrorResponse', 

344 '404': 'ErrorResponse', 

345 '429': 'ErrorResponse', 

346 '500': 'ErrorResponse', 

347 } 

348 

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

350 response_data.read() 

351 return self.api_client.response_deserialize( 

352 response_data=response_data, 

353 response_types_map=_response_types_map, 

354 ).data 

355 

356 @validate_call 

357 def get_event_with_http_info( 

358 self, 

359 event_id: Annotated[ 

360 StrictStr, 

361 Field( 

362 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).' 

363 ), 

364 ], 

365 ruleset_id: Annotated[ 

366 Optional[StrictStr], 

367 Field( 

368 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. ' 

369 ), 

370 ] = None, 

371 _request_timeout: Union[ 

372 None, 

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

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

375 ] = None, 

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

377 _content_type: Optional[StrictStr] = None, 

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

379 ) -> ApiResponse[Event]: 

380 """Get an event by event ID 

381 

382 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`. 

383 

384 :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) 

385 :type event_id: str 

386 :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. 

387 :type ruleset_id: str 

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

389 number provided, it will be total request 

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

391 (connection, read) timeouts. 

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

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

394 request; this effectively ignores the 

395 authentication in the spec for a single request. 

396 :type _request_auth: dict, optional 

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

398 :type _content_type: str, Optional 

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

400 request; this effectively ignores the headers 

401 in the spec for a single request. 

402 :type _headers: dict, optional 

403 :return: Returns the result object. 

404 """ # noqa: E501 

405 

406 _param = self._get_event_serialize( 

407 event_id=event_id, 

408 ruleset_id=ruleset_id, 

409 _request_auth=_request_auth, 

410 _content_type=_content_type, 

411 _headers=_headers, 

412 ) 

413 

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

415 '200': 'Event', 

416 '400': 'ErrorResponse', 

417 '403': 'ErrorResponse', 

418 '404': 'ErrorResponse', 

419 '429': 'ErrorResponse', 

420 '500': 'ErrorResponse', 

421 } 

422 

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

424 response_data.read() 

425 return self.api_client.response_deserialize( 

426 response_data=response_data, 

427 response_types_map=_response_types_map, 

428 ) 

429 

430 @validate_call 

431 def get_event_without_preload_content( 

432 self, 

433 event_id: Annotated[ 

434 StrictStr, 

435 Field( 

436 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).' 

437 ), 

438 ], 

439 ruleset_id: Annotated[ 

440 Optional[StrictStr], 

441 Field( 

442 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. ' 

443 ), 

444 ] = None, 

445 _request_timeout: Union[ 

446 None, 

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

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

449 ] = None, 

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

451 _content_type: Optional[StrictStr] = None, 

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

453 ) -> RESTResponseType: 

454 """Get an event by event ID 

455 

456 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`. 

457 

458 :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) 

459 :type event_id: str 

460 :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. 

461 :type ruleset_id: str 

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

463 number provided, it will be total request 

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

465 (connection, read) timeouts. 

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

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

468 request; this effectively ignores the 

469 authentication in the spec for a single request. 

470 :type _request_auth: dict, optional 

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

472 :type _content_type: str, Optional 

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

474 request; this effectively ignores the headers 

475 in the spec for a single request. 

476 :type _headers: dict, optional 

477 :return: Returns the result object. 

478 """ # noqa: E501 

479 

480 _param = self._get_event_serialize( 

481 event_id=event_id, 

482 ruleset_id=ruleset_id, 

483 _request_auth=_request_auth, 

484 _content_type=_content_type, 

485 _headers=_headers, 

486 ) 

487 

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

489 '200': 'Event', 

490 '400': 'ErrorResponse', 

491 '403': 'ErrorResponse', 

492 '404': 'ErrorResponse', 

493 '429': 'ErrorResponse', 

494 '500': 'ErrorResponse', 

495 } 

496 

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

498 return response_data.response 

499 

500 def _get_event_serialize( 

501 self, 

502 event_id: str, 

503 ruleset_id: Optional[str], 

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

505 _content_type: Optional[StrictStr], 

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

507 ) -> RequestSerialized: 

508 

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

510 

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

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

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

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

515 _files: dict[ 

516 str, 

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

518 ] = {} 

519 _body_params: Optional[Any] = None 

520 

521 # process the path parameters 

522 if event_id is not None: 

523 _path_params['event_id'] = event_id 

524 

525 # process the query parameters 

526 if ruleset_id is not None: 

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

528 

529 # set the HTTP header `Accept` 

530 if 'Accept' not in _header_params: 

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

532 

533 # authentication setting 

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

535 

536 return self.api_client.param_serialize( 

537 method='GET', 

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

539 path_params=_path_params, 

540 query_params=_query_params, 

541 header_params=_header_params, 

542 body=_body_params, 

543 post_params=_form_params, 

544 files=_files, 

545 auth_settings=_auth_settings, 

546 collection_formats=_collection_formats, 

547 _request_auth=_request_auth, 

548 ) 

549 

550 @validate_call 

551 def search_events( 

552 self, 

553 limit: Annotated[ 

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

555 Field( 

556 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. ' 

557 ), 

558 ] = None, 

559 pagination_key: Annotated[ 

560 Optional[StrictStr], 

561 Field( 

562 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 200 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` ' 

563 ), 

564 ] = None, 

565 visitor_id: Annotated[ 

566 Optional[StrictStr], 

567 Field( 

568 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). ' 

569 ), 

570 ] = None, 

571 high_recall_id: Annotated[ 

572 Optional[StrictStr], 

573 Field( 

574 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). ' 

575 ), 

576 ] = None, 

577 bot: Annotated[ 

578 Optional[SearchEventsBot], 

579 Field( 

580 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. ' 

581 ), 

582 ] = None, 

583 ip_address: Annotated[ 

584 Optional[StrictStr], 

585 Field( 

586 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 ' 

587 ), 

588 ] = None, 

589 asn: Annotated[ 

590 Optional[StrictStr], 

591 Field( 

592 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. " 

593 ), 

594 ] = None, 

595 linked_id: Annotated[ 

596 Optional[StrictStr], 

597 Field( 

598 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. ' 

599 ), 

600 ] = None, 

601 url: Annotated[ 

602 Optional[StrictStr], 

603 Field( 

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

605 ), 

606 ] = None, 

607 bundle_id: Annotated[ 

608 Optional[StrictStr], 

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

610 ] = None, 

611 package_name: Annotated[ 

612 Optional[StrictStr], 

613 Field( 

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

615 ), 

616 ] = None, 

617 origin: Annotated[ 

618 Optional[StrictStr], 

619 Field( 

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

621 ), 

622 ] = None, 

623 start: Annotated[ 

624 Optional[StrictInt], 

625 Field( 

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

627 ), 

628 ] = None, 

629 end: Annotated[ 

630 Optional[StrictInt], 

631 Field( 

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

633 ), 

634 ] = None, 

635 reverse: Annotated[ 

636 Optional[StrictBool], 

637 Field( 

638 description='When `true`, sort events oldest first (ascending timestamp order). Default is newest first (descending timestamp order). ' 

639 ), 

640 ] = None, 

641 suspect: Annotated[ 

642 Optional[StrictBool], 

643 Field( 

644 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. ' 

645 ), 

646 ] = None, 

647 vpn: Annotated[ 

648 Optional[StrictBool], 

649 Field( 

650 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. ' 

651 ), 

652 ] = None, 

653 virtual_machine: Annotated[ 

654 Optional[StrictBool], 

655 Field( 

656 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. ' 

657 ), 

658 ] = None, 

659 tampering: Annotated[ 

660 Optional[StrictBool], 

661 Field( 

662 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. ' 

663 ), 

664 ] = None, 

665 anti_detect_browser: Annotated[ 

666 Optional[StrictBool], 

667 Field( 

668 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. ' 

669 ), 

670 ] = None, 

671 incognito: Annotated[ 

672 Optional[StrictBool], 

673 Field( 

674 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. ' 

675 ), 

676 ] = None, 

677 privacy_settings: Annotated[ 

678 Optional[StrictBool], 

679 Field( 

680 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. ' 

681 ), 

682 ] = None, 

683 jailbroken: Annotated[ 

684 Optional[StrictBool], 

685 Field( 

686 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. ' 

687 ), 

688 ] = None, 

689 frida: Annotated[ 

690 Optional[StrictBool], 

691 Field( 

692 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. ' 

693 ), 

694 ] = None, 

695 factory_reset: Annotated[ 

696 Optional[StrictBool], 

697 Field( 

698 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. ' 

699 ), 

700 ] = None, 

701 cloned_app: Annotated[ 

702 Optional[StrictBool], 

703 Field( 

704 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. ' 

705 ), 

706 ] = None, 

707 emulator: Annotated[ 

708 Optional[StrictBool], 

709 Field( 

710 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. ' 

711 ), 

712 ] = None, 

713 root_apps: Annotated[ 

714 Optional[StrictBool], 

715 Field( 

716 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. ' 

717 ), 

718 ] = None, 

719 vpn_confidence: Annotated[ 

720 Optional[SearchEventsVpnConfidence], 

721 Field( 

722 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. ' 

723 ), 

724 ] = None, 

725 min_suspect_score: Annotated[ 

726 Optional[Union[StrictFloat, StrictInt]], 

727 Field( 

728 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. ' 

729 ), 

730 ] = None, 

731 developer_tools: Annotated[ 

732 Optional[StrictBool], 

733 Field( 

734 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. ' 

735 ), 

736 ] = None, 

737 location_spoofing: Annotated[ 

738 Optional[StrictBool], 

739 Field( 

740 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. ' 

741 ), 

742 ] = None, 

743 mitm_attack: Annotated[ 

744 Optional[StrictBool], 

745 Field( 

746 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. ' 

747 ), 

748 ] = None, 

749 rare_device: Annotated[ 

750 Optional[StrictBool], 

751 Field( 

752 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. ' 

753 ), 

754 ] = None, 

755 rare_device_percentile_bucket: Annotated[ 

756 Optional[SearchEventsRareDevicePercentileBucket], 

757 Field( 

758 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. ' 

759 ), 

760 ] = None, 

761 proxy: Annotated[ 

762 Optional[StrictBool], 

763 Field( 

764 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. ' 

765 ), 

766 ] = None, 

767 sdk_version: Annotated[ 

768 Optional[StrictStr], 

769 Field( 

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

771 ), 

772 ] = None, 

773 sdk_platform: Annotated[ 

774 Optional[SearchEventsSdkPlatform], 

775 Field( 

776 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. ' 

777 ), 

778 ] = None, 

779 environment: Annotated[ 

780 Optional[list[StrictStr]], 

781 Field( 

782 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. ' 

783 ), 

784 ] = None, 

785 proximity_id: Annotated[ 

786 Optional[StrictStr], 

787 Field( 

788 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. ' 

789 ), 

790 ] = None, 

791 total_hits: Annotated[ 

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

793 Field( 

794 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. ' 

795 ), 

796 ] = None, 

797 tor_node: Annotated[ 

798 Optional[StrictBool], 

799 Field( 

800 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. ' 

801 ), 

802 ] = None, 

803 incremental_identification_status: Annotated[ 

804 Optional[SearchEventsIncrementalIdentificationStatus], 

805 Field( 

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

807 ), 

808 ] = None, 

809 simulator: Annotated[ 

810 Optional[StrictBool], 

811 Field( 

812 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. ' 

813 ), 

814 ] = None, 

815 _request_timeout: Union[ 

816 None, 

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

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

819 ] = None, 

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

821 _content_type: Optional[StrictStr] = None, 

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

823 ) -> EventSearch: 

824 """Search events 

825 

826 ## 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. 

827 

828 :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. 

829 :type limit: int 

830 :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 200 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` 

831 :type pagination_key: str 

832 :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). 

833 :type visitor_id: str 

834 :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). 

835 :type high_recall_id: str 

836 :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. 

837 :type bot: SearchEventsBot 

838 :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 

839 :type ip_address: str 

840 :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. 

841 :type asn: str 

842 :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. 

843 :type linked_id: str 

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

845 :type url: str 

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

847 :type bundle_id: str 

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

849 :type package_name: str 

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

851 :type origin: str 

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

853 :type start: int 

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

855 :type end: int 

856 :param reverse: When `true`, sort events oldest first (ascending timestamp order). Default is newest first (descending timestamp order). 

857 :type reverse: bool 

858 :param suspect: 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. 

859 :type suspect: bool 

860 :param vpn: 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. 

861 :type vpn: bool 

862 :param virtual_machine: 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. 

863 :type virtual_machine: bool 

864 :param tampering: 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. 

865 :type tampering: bool 

866 :param anti_detect_browser: 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. 

867 :type anti_detect_browser: bool 

868 :param incognito: 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. 

869 :type incognito: bool 

870 :param privacy_settings: 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. 

871 :type privacy_settings: bool 

872 :param jailbroken: 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. 

873 :type jailbroken: bool 

874 :param frida: 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. 

875 :type frida: bool 

876 :param factory_reset: 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. 

877 :type factory_reset: bool 

878 :param cloned_app: 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. 

879 :type cloned_app: bool 

880 :param emulator: 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. 

881 :type emulator: bool 

882 :param root_apps: 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. 

883 :type root_apps: bool 

884 :param vpn_confidence: 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. 

885 :type vpn_confidence: SearchEventsVpnConfidence 

886 :param min_suspect_score: 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. 

887 :type min_suspect_score: float 

888 :param developer_tools: 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. 

889 :type developer_tools: bool 

890 :param location_spoofing: 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. 

891 :type location_spoofing: bool 

892 :param mitm_attack: 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. 

893 :type mitm_attack: bool 

894 :param rare_device: 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. 

895 :type rare_device: bool 

896 :param rare_device_percentile_bucket: 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. 

897 :type rare_device_percentile_bucket: SearchEventsRareDevicePercentileBucket 

898 :param proxy: 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. 

899 :type proxy: bool 

900 :param sdk_version: Filter events by a specific SDK version associated with the identification event (`sdk.version` property). Example: `3.11.14` 

901 :type sdk_version: str 

902 :param sdk_platform: 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. 

903 :type sdk_platform: SearchEventsSdkPlatform 

904 :param environment: 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. 

905 :type environment: List[str] 

906 :param proximity_id: 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. 

907 :type proximity_id: str 

908 :param total_hits: 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. 

909 :type total_hits: int 

910 :param tor_node: 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. 

911 :type tor_node: bool 

912 :param incremental_identification_status: Filter events by their incremental identification status (`incremental_identification_status` property). Non incremental identification events are left out of the response. 

913 :type incremental_identification_status: SearchEventsIncrementalIdentificationStatus 

914 :param simulator: 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. 

915 :type simulator: bool 

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

917 number provided, it will be total request 

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

919 (connection, read) timeouts. 

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

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

922 request; this effectively ignores the 

923 authentication in the spec for a single request. 

924 :type _request_auth: dict, optional 

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

926 :type _content_type: str, Optional 

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

928 request; this effectively ignores the headers 

929 in the spec for a single request. 

930 :type _headers: dict, optional 

931 :return: Returns the result object. 

932 """ # noqa: E501 

933 

934 _param = self._search_events_serialize( 

935 limit=limit, 

936 pagination_key=pagination_key, 

937 visitor_id=visitor_id, 

938 high_recall_id=high_recall_id, 

939 bot=bot, 

940 ip_address=ip_address,