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_sdk_platform import SearchEventsSdkPlatform 

28from fingerprint_server_sdk.models.search_events_vpn_confidence import SearchEventsVpnConfidence 

29from fingerprint_server_sdk.rest import RESTResponseType 

30 

31# Type alias for query and form parameter values 

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

33 

34 

35class FingerprintApi: 

36 """Fingerprint Python Server SDK 

37 

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

39 

40 :param configuration: API client configuration. 

41 """ 

42 

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

44 self.api_client = ApiClient(configuration) 

45 

46 @validate_call 

47 def delete_visitor_data( 

48 self, 

49 visitor_id: Annotated[ 

50 StrictStr, 

51 Field( 

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

53 ), 

54 ], 

55 _request_timeout: Union[ 

56 None, 

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

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

59 ] = None, 

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

61 _content_type: Optional[StrictStr] = None, 

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

63 ) -> None: 

64 """Delete data by visitor ID 

65 

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

67 

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

69 :type visitor_id: str 

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

71 number provided, it will be total request 

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

73 (connection, read) timeouts. 

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

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

76 request; this effectively ignores the 

77 authentication in the spec for a single request. 

78 :type _request_auth: dict, optional 

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

80 :type _content_type: str, Optional 

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

82 request; this effectively ignores the headers 

83 in the spec for a single request. 

84 :type _headers: dict, optional 

85 :return: Returns the result object. 

86 """ # noqa: E501 

87 

88 _param = self._delete_visitor_data_serialize( 

89 visitor_id=visitor_id, 

90 _request_auth=_request_auth, 

91 _content_type=_content_type, 

92 _headers=_headers, 

93 ) 

94 

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

96 '200': None, 

97 '400': 'ErrorResponse', 

98 '403': 'ErrorResponse', 

99 '404': 'ErrorResponse', 

100 '429': 'ErrorResponse', 

101 } 

102 

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

104 response_data.read() 

105 self.api_client.response_deserialize( 

106 response_data=response_data, 

107 response_types_map=_response_types_map, 

108 ) 

109 

110 @validate_call 

111 def delete_visitor_data_with_http_info( 

112 self, 

113 visitor_id: Annotated[ 

114 StrictStr, 

115 Field( 

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

117 ), 

118 ], 

119 _request_timeout: Union[ 

120 None, 

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

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

123 ] = None, 

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

125 _content_type: Optional[StrictStr] = None, 

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

127 ) -> ApiResponse[None]: 

128 """Delete data by visitor ID 

129 

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

131 

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

133 :type visitor_id: str 

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

135 number provided, it will be total request 

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

137 (connection, read) timeouts. 

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

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

140 request; this effectively ignores the 

141 authentication in the spec for a single request. 

142 :type _request_auth: dict, optional 

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

144 :type _content_type: str, Optional 

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

146 request; this effectively ignores the headers 

147 in the spec for a single request. 

148 :type _headers: dict, optional 

149 :return: Returns the result object. 

150 """ # noqa: E501 

151 

152 _param = self._delete_visitor_data_serialize( 

153 visitor_id=visitor_id, 

154 _request_auth=_request_auth, 

155 _content_type=_content_type, 

156 _headers=_headers, 

157 ) 

158 

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

160 '200': None, 

161 '400': 'ErrorResponse', 

162 '403': 'ErrorResponse', 

163 '404': 'ErrorResponse', 

164 '429': 'ErrorResponse', 

165 } 

166 

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

168 response_data.read() 

169 return self.api_client.response_deserialize( 

170 response_data=response_data, 

171 response_types_map=_response_types_map, 

172 ) 

173 

174 @validate_call 

175 def delete_visitor_data_without_preload_content( 

176 self, 

177 visitor_id: Annotated[ 

178 StrictStr, 

179 Field( 

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

181 ), 

182 ], 

183 _request_timeout: Union[ 

184 None, 

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

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

187 ] = None, 

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

189 _content_type: Optional[StrictStr] = None, 

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

191 ) -> RESTResponseType: 

192 """Delete data by visitor ID 

193 

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

195 

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

197 :type visitor_id: str 

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

199 number provided, it will be total request 

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

201 (connection, read) timeouts. 

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

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

204 request; this effectively ignores the 

205 authentication in the spec for a single request. 

206 :type _request_auth: dict, optional 

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

208 :type _content_type: str, Optional 

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

210 request; this effectively ignores the headers 

211 in the spec for a single request. 

212 :type _headers: dict, optional 

213 :return: Returns the result object. 

214 """ # noqa: E501 

215 

216 _param = self._delete_visitor_data_serialize( 

217 visitor_id=visitor_id, 

218 _request_auth=_request_auth, 

219 _content_type=_content_type, 

220 _headers=_headers, 

221 ) 

222 

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

224 '200': None, 

225 '400': 'ErrorResponse', 

226 '403': 'ErrorResponse', 

227 '404': 'ErrorResponse', 

228 '429': 'ErrorResponse', 

229 } 

230 

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

232 return response_data.response 

233 

234 def _delete_visitor_data_serialize( 

235 self, 

236 visitor_id: str, 

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

238 _content_type: Optional[StrictStr], 

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

240 ) -> RequestSerialized: 

241 

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

243 

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

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

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

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

248 _files: dict[ 

249 str, 

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

251 ] = {} 

252 _body_params: Optional[Any] = None 

253 

254 # process the path parameters 

255 if visitor_id is not None: 

256 _path_params['visitor_id'] = visitor_id 

257 

258 # set the HTTP header `Accept` 

259 if 'Accept' not in _header_params: 

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

261 

262 # authentication setting 

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

264 

265 return self.api_client.param_serialize( 

266 method='DELETE', 

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

268 path_params=_path_params, 

269 query_params=_query_params, 

270 header_params=_header_params, 

271 body=_body_params, 

272 post_params=_form_params, 

273 files=_files, 

274 auth_settings=_auth_settings, 

275 collection_formats=_collection_formats, 

276 _request_auth=_request_auth, 

277 ) 

278 

279 @validate_call 

280 def get_event( 

281 self, 

282 event_id: Annotated[ 

283 StrictStr, 

284 Field( 

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

286 ), 

287 ], 

288 ruleset_id: Annotated[ 

289 Optional[StrictStr], 

290 Field( 

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

292 ), 

293 ] = None, 

294 _request_timeout: Union[ 

295 None, 

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

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

298 ] = None, 

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

300 _content_type: Optional[StrictStr] = None, 

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

302 ) -> Event: 

303 """Get an event by event ID 

304 

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

306 

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

308 :type event_id: str 

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

310 :type ruleset_id: str 

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

312 number provided, it will be total request 

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

314 (connection, read) timeouts. 

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

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

317 request; this effectively ignores the 

318 authentication in the spec for a single request. 

319 :type _request_auth: dict, optional 

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

321 :type _content_type: str, Optional 

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

323 request; this effectively ignores the headers 

324 in the spec for a single request. 

325 :type _headers: dict, optional 

326 :return: Returns the result object. 

327 """ # noqa: E501 

328 

329 _param = self._get_event_serialize( 

330 event_id=event_id, 

331 ruleset_id=ruleset_id, 

332 _request_auth=_request_auth, 

333 _content_type=_content_type, 

334 _headers=_headers, 

335 ) 

336 

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

338 '200': 'Event', 

339 '400': 'ErrorResponse', 

340 '403': 'ErrorResponse', 

341 '404': 'ErrorResponse', 

342 '429': 'ErrorResponse', 

343 '500': 'ErrorResponse', 

344 } 

345 

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

347 response_data.read() 

348 return self.api_client.response_deserialize( 

349 response_data=response_data, 

350 response_types_map=_response_types_map, 

351 ).data 

352 

353 @validate_call 

354 def get_event_with_http_info( 

355 self, 

356 event_id: Annotated[ 

357 StrictStr, 

358 Field( 

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

360 ), 

361 ], 

362 ruleset_id: Annotated[ 

363 Optional[StrictStr], 

364 Field( 

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

366 ), 

367 ] = None, 

368 _request_timeout: Union[ 

369 None, 

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

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

372 ] = None, 

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

374 _content_type: Optional[StrictStr] = None, 

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

376 ) -> ApiResponse[Event]: 

377 """Get an event by event ID 

378 

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

380 

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

382 :type event_id: str 

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

384 :type ruleset_id: str 

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

386 number provided, it will be total request 

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

388 (connection, read) timeouts. 

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

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

391 request; this effectively ignores the 

392 authentication in the spec for a single request. 

393 :type _request_auth: dict, optional 

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

395 :type _content_type: str, Optional 

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

397 request; this effectively ignores the headers 

398 in the spec for a single request. 

399 :type _headers: dict, optional 

400 :return: Returns the result object. 

401 """ # noqa: E501 

402 

403 _param = self._get_event_serialize( 

404 event_id=event_id, 

405 ruleset_id=ruleset_id, 

406 _request_auth=_request_auth, 

407 _content_type=_content_type, 

408 _headers=_headers, 

409 ) 

410 

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

412 '200': 'Event', 

413 '400': 'ErrorResponse', 

414 '403': 'ErrorResponse', 

415 '404': 'ErrorResponse', 

416 '429': 'ErrorResponse', 

417 '500': 'ErrorResponse', 

418 } 

419 

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

421 response_data.read() 

422 return self.api_client.response_deserialize( 

423 response_data=response_data, 

424 response_types_map=_response_types_map, 

425 ) 

426 

427 @validate_call 

428 def get_event_without_preload_content( 

429 self, 

430 event_id: Annotated[ 

431 StrictStr, 

432 Field( 

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

434 ), 

435 ], 

436 ruleset_id: Annotated[ 

437 Optional[StrictStr], 

438 Field( 

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

440 ), 

441 ] = None, 

442 _request_timeout: Union[ 

443 None, 

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

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

446 ] = None, 

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

448 _content_type: Optional[StrictStr] = None, 

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

450 ) -> RESTResponseType: 

451 """Get an event by event ID 

452 

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

454 

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

456 :type event_id: str 

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

458 :type ruleset_id: str 

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

460 number provided, it will be total request 

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

462 (connection, read) timeouts. 

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

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

465 request; this effectively ignores the 

466 authentication in the spec for a single request. 

467 :type _request_auth: dict, optional 

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

469 :type _content_type: str, Optional 

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

471 request; this effectively ignores the headers 

472 in the spec for a single request. 

473 :type _headers: dict, optional 

474 :return: Returns the result object. 

475 """ # noqa: E501 

476 

477 _param = self._get_event_serialize( 

478 event_id=event_id, 

479 ruleset_id=ruleset_id, 

480 _request_auth=_request_auth, 

481 _content_type=_content_type, 

482 _headers=_headers, 

483 ) 

484 

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

486 '200': 'Event', 

487 '400': 'ErrorResponse', 

488 '403': 'ErrorResponse', 

489 '404': 'ErrorResponse', 

490 '429': 'ErrorResponse', 

491 '500': 'ErrorResponse', 

492 } 

493 

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

495 return response_data.response 

496 

497 def _get_event_serialize( 

498 self, 

499 event_id: str, 

500 ruleset_id: Optional[str], 

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

502 _content_type: Optional[StrictStr], 

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

504 ) -> RequestSerialized: 

505 

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

507 

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

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

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

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

512 _files: dict[ 

513 str, 

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

515 ] = {} 

516 _body_params: Optional[Any] = None 

517 

518 # process the path parameters 

519 if event_id is not None: 

520 _path_params['event_id'] = event_id 

521 

522 # process the query parameters 

523 if ruleset_id is not None: 

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

525 

526 # set the HTTP header `Accept` 

527 if 'Accept' not in _header_params: 

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

529 

530 # authentication setting 

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

532 

533 return self.api_client.param_serialize( 

534 method='GET', 

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

536 path_params=_path_params, 

537 query_params=_query_params, 

538 header_params=_header_params, 

539 body=_body_params, 

540 post_params=_form_params, 

541 files=_files, 

542 auth_settings=_auth_settings, 

543 collection_formats=_collection_formats, 

544 _request_auth=_request_auth, 

545 ) 

546 

547 @validate_call 

548 def search_events( 

549 self, 

550 limit: Annotated[ 

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

552 Field(description='Limit the number of events returned. '), 

553 ] = None, 

554 pagination_key: Annotated[ 

555 Optional[StrictStr], 

556 Field( 

557 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` ' 

558 ), 

559 ] = None, 

560 visitor_id: Annotated[ 

561 Optional[StrictStr], 

562 Field( 

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

564 ), 

565 ] = None, 

566 high_recall_id: Annotated[ 

567 Optional[StrictStr], 

568 Field( 

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

570 ), 

571 ] = None, 

572 bot: Annotated[ 

573 Optional[SearchEventsBot], 

574 Field( 

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

576 ), 

577 ] = None, 

578 ip_address: Annotated[ 

579 Optional[StrictStr], 

580 Field( 

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

582 ), 

583 ] = None, 

584 asn: Annotated[ 

585 Optional[StrictStr], 

586 Field( 

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

588 ), 

589 ] = None, 

590 linked_id: Annotated[ 

591 Optional[StrictStr], 

592 Field( 

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

594 ), 

595 ] = None, 

596 url: Annotated[ 

597 Optional[StrictStr], 

598 Field( 

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

600 ), 

601 ] = None, 

602 bundle_id: Annotated[ 

603 Optional[StrictStr], 

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

605 ] = None, 

606 package_name: Annotated[ 

607 Optional[StrictStr], 

608 Field( 

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

610 ), 

611 ] = None, 

612 origin: Annotated[ 

613 Optional[StrictStr], 

614 Field( 

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

616 ), 

617 ] = None, 

618 start: Annotated[ 

619 Optional[StrictInt], 

620 Field( 

621 description='Filter events with a timestamp greater than the start time, in Unix time (milliseconds). ' 

622 ), 

623 ] = None, 

624 end: Annotated[ 

625 Optional[StrictInt], 

626 Field( 

627 description='Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). ' 

628 ), 

629 ] = None, 

630 reverse: Annotated[ 

631 Optional[StrictBool], Field(description='Sort events in reverse timestamp order. ') 

632 ] = None, 

633 suspect: Annotated[ 

634 Optional[StrictBool], 

635 Field( 

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

637 ), 

638 ] = None, 

639 vpn: Annotated[ 

640 Optional[StrictBool], 

641 Field( 

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

643 ), 

644 ] = None, 

645 virtual_machine: Annotated[ 

646 Optional[StrictBool], 

647 Field( 

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

649 ), 

650 ] = None, 

651 tampering: Annotated[ 

652 Optional[StrictBool], 

653 Field( 

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

655 ), 

656 ] = None, 

657 anti_detect_browser: Annotated[ 

658 Optional[StrictBool], 

659 Field( 

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

661 ), 

662 ] = None, 

663 incognito: Annotated[ 

664 Optional[StrictBool], 

665 Field( 

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

667 ), 

668 ] = None, 

669 privacy_settings: Annotated[ 

670 Optional[StrictBool], 

671 Field( 

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

673 ), 

674 ] = None, 

675 jailbroken: Annotated[ 

676 Optional[StrictBool], 

677 Field( 

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

679 ), 

680 ] = None, 

681 frida: Annotated[ 

682 Optional[StrictBool], 

683 Field( 

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

685 ), 

686 ] = None, 

687 factory_reset: Annotated[ 

688 Optional[StrictBool], 

689 Field( 

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

691 ), 

692 ] = None, 

693 cloned_app: Annotated[ 

694 Optional[StrictBool], 

695 Field( 

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

697 ), 

698 ] = None, 

699 emulator: Annotated[ 

700 Optional[StrictBool], 

701 Field( 

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

703 ), 

704 ] = None, 

705 root_apps: Annotated[ 

706 Optional[StrictBool], 

707 Field( 

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

709 ), 

710 ] = None, 

711 vpn_confidence: Annotated[ 

712 Optional[SearchEventsVpnConfidence], 

713 Field( 

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

715 ), 

716 ] = None, 

717 min_suspect_score: Annotated[ 

718 Optional[Union[StrictFloat, StrictInt]], 

719 Field( 

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

721 ), 

722 ] = None, 

723 developer_tools: Annotated[ 

724 Optional[StrictBool], 

725 Field( 

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

727 ), 

728 ] = None, 

729 location_spoofing: Annotated[ 

730 Optional[StrictBool], 

731 Field( 

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

733 ), 

734 ] = None, 

735 mitm_attack: Annotated[ 

736 Optional[StrictBool], 

737 Field( 

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

739 ), 

740 ] = None, 

741 proxy: Annotated[ 

742 Optional[StrictBool], 

743 Field( 

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

745 ), 

746 ] = None, 

747 sdk_version: Annotated[ 

748 Optional[StrictStr], 

749 Field( 

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

751 ), 

752 ] = None, 

753 sdk_platform: Annotated[ 

754 Optional[SearchEventsSdkPlatform], 

755 Field( 

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

757 ), 

758 ] = None, 

759 environment: Annotated[ 

760 Optional[list[StrictStr]], 

761 Field( 

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

763 ), 

764 ] = None, 

765 proximity_id: Annotated[ 

766 Optional[StrictStr], 

767 Field( 

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

769 ), 

770 ] = None, 

771 total_hits: Annotated[ 

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

773 Field( 

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

775 ), 

776 ] = None, 

777 tor_node: Annotated[ 

778 Optional[StrictBool], 

779 Field( 

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

781 ), 

782 ] = None, 

783 incremental_identification_status: Annotated[ 

784 Optional[SearchEventsIncrementalIdentificationStatus], 

785 Field( 

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

787 ), 

788 ] = None, 

789 simulator: Annotated[ 

790 Optional[StrictBool], 

791 Field( 

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

793 ), 

794 ] = None, 

795 _request_timeout: Union[ 

796 None, 

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

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

799 ] = None, 

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

801 _content_type: Optional[StrictStr] = None, 

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

803 ) -> EventSearch: 

804 """Search events 

805 

806 ## 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) If you don't provide `start` or `end` parameters, the default search range is the **last 7 days**. ### 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. 

807 

808 :param limit: Limit the number of events returned. 

809 :type limit: int 

810 :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` 

811 :type pagination_key: str 

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

813 :type visitor_id: str 

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

815 :type high_recall_id: str 

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

817 :type bot: SearchEventsBot 

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

819 :type ip_address: str 

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

821 :type asn: str 

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

823 :type linked_id: str 

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

825 :type url: str 

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

827 :type bundle_id: str 

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

829 :type package_name: str 

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

831 :type origin: str 

832 :param start: Filter events with a timestamp greater than the start time, in Unix time (milliseconds). 

833 :type start: int 

834 :param end: Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). 

835 :type end: int 

836 :param reverse: Sort events in reverse timestamp order. 

837 :type reverse: bool 

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

839 :type suspect: bool 

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

841 :type vpn: bool 

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

843 :type virtual_machine: bool 

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

845 :type tampering: bool 

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

847 :type anti_detect_browser: bool 

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

849 :type incognito: bool 

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

851 :type privacy_settings: bool 

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

853 :type jailbroken: bool 

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

855 :type frida: bool 

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

857 :type factory_reset: bool 

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

859 :type cloned_app: bool 

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

861 :type emulator: bool 

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

863 :type root_apps: bool 

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

865 :type vpn_confidence: SearchEventsVpnConfidence 

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

867 :type min_suspect_score: float 

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

869 :type developer_tools: bool 

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

871 :type location_spoofing: bool 

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

873 :type mitm_attack: bool 

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

875 :type proxy: bool 

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

877 :type sdk_version: str 

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

879 :type sdk_platform: SearchEventsSdkPlatform 

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

881 :type environment: List[str] 

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

883 :type proximity_id: str 

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

885 :type total_hits: int 

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

887 :type tor_node: bool 

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

889 :type incremental_identification_status: SearchEventsIncrementalIdentificationStatus 

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

891 :type simulator: bool 

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

893 number provided, it will be total request 

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

895 (connection, read) timeouts. 

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

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

898 request; this effectively ignores the 

899 authentication in the spec for a single request. 

900 :type _request_auth: dict, optional 

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

902 :type _content_type: str, Optional 

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

904 request; this effectively ignores the headers 

905 in the spec for a single request. 

906 :type _headers: dict, optional 

907 :return: Returns the result object. 

908 """ # noqa: E501 

909 

910 _param = self._search_events_serialize( 

911 limit=limit, 

912 pagination_key=pagination_key, 

913 visitor_id=visitor_id, 

914 high_recall_id=high_recall_id, 

915 bot=bot, 

916 ip_address=ip_address, 

917 asn=asn, 

918 linked_id=linked_id, 

919 url=url, 

920 bundle_id=bundle_id, 

921 package_name=package_name, 

922 origin=origin, 

923 start=start, 

924 end=end, 

925 reverse=reverse, 

926 suspect=suspect, 

927 vpn=vpn, 

928 virtual_machine=virtual_machine, 

929 tampering=tampering, 

930 anti_detect_browser=anti_detect_browser, 

931 incognito=incognito, 

932 privacy_settings=privacy_settings, 

933 jailbroken=jailbroken, 

934 frida=frida, 

935 factory_reset=factory_reset,