fingerprint_server_sdk.FingerprintApi

All URIs are relative to https://api.fpjs.io/v4

Method	HTTP request	Description
delete_visitor_data	DELETE /visitors/{visitor_id}	Delete data by visitor ID
get_event	GET /events/{event_id}	Get an event by event ID
search_events	GET /events	Search events
update_event	PATCH /events/{event_id}	Update an event

delete_visitor_data

delete_visitor_data(visitor_id)

Delete data by visitor ID

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.

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.
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 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 to enable it for you. Otherwise, you will receive a 403.

Example

import os

import fingerprint_server_sdk
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

# Configure API key authorization and region
configuration = fingerprint_server_sdk.Configuration(
    api_key = os.environ["SECRET_API_KEY"],
    region = Region.US
)

# Create an instance of the API class
api_instance = fingerprint_server_sdk.FingerprintApi(configuration)

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

try:
    # Delete data by visitor ID
    api_instance.delete_visitor_data(visitor_id)
except Exception as e:
    print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
visitor_id	str	The visitor ID you want to delete.

Return type

void (empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK. The visitor ID is scheduled for deletion.	-
400	Bad request. The visitor ID parameter is missing or in the wrong format.	-
403	Forbidden. Access to this API is denied.	-
404	Not found. The visitor ID cannot be found in this workspace's data.	-
429	Too Many Requests. The request is throttled.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_event

Event get_event(event_id, ruleset_id=ruleset_id)

Get an event by event ID

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.

Example

import os

import fingerprint_server_sdk
from fingerprint_server_sdk.models.event import Event
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

# Configure API key authorization and region
configuration = fingerprint_server_sdk.Configuration(
    api_key = os.environ["SECRET_API_KEY"],
    region = Region.US
)

# Create an instance of the API class
api_instance = fingerprint_server_sdk.FingerprintApi(configuration)

event_id: str = 'event_id_example' # 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).
ruleset_id: str = 'ruleset_id_example' # 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.  (optional)

try:
    # Get an event by event ID
    api_response = api_instance.get_event(event_id, ruleset_id=ruleset_id)
    print("The response of FingerprintApi->get_event:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling FingerprintApi->get_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_id	str	The unique identifier of each identification request (`requestId` can be used in its place).
ruleset_id	str	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.	[optional]

Return type

Event

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK.	-
400	Bad request. The event Id provided is not valid.	-
403	Forbidden. Access to this API is denied.	-
404	Not found. The event Id cannot be found in this workspace's data.	-
429	Too Many Requests. The request is throttled.	-
500	Workspace error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_events

EventSearch search_events(limit=limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, asn=asn, linked_id=linked_id, url=url, bundle_id=bundle_id, package_name=package_name, origin=origin, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, total_hits=total_hits, tor_node=tor_node)

Search events

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.

Example

import os

import fingerprint_server_sdk
from fingerprint_server_sdk.models.event_search import EventSearch
from fingerprint_server_sdk.models.search_events_bot import SearchEventsBot
from fingerprint_server_sdk.models.search_events_sdk_platform import SearchEventsSdkPlatform
from fingerprint_server_sdk.models.search_events_vpn_confidence import SearchEventsVpnConfidence
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

# Configure API key authorization and region
configuration = fingerprint_server_sdk.Configuration(
    api_key = os.environ["SECRET_API_KEY"],
    region = Region.US
)

# Create an instance of the API class
api_instance = fingerprint_server_sdk.FingerprintApi(configuration)

limit: int = 10 # Limit the number of events returned.  (optional) (default to 10)
pagination_key: str = 'pagination_key_example' # 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`  (optional)
visitor_id: str = 'visitor_id_example' # 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 for events matching this `visitor_id`.  (optional)
bot: SearchEventsBot = fingerprint_server_sdk.SearchEventsBot() # 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.  (optional)
ip_address: str = 'ip_address_example' # 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  (optional)
asn: str = 'asn_example' # 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.  (optional)
linked_id: str = 'linked_id_example' # 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.  (optional)
url: str = 'url_example' # Filter events by the URL (`url` property) associated with the event.  (optional)
bundle_id: str = 'bundle_id_example' # Filter events by the Bundle ID (iOS) associated with the event.  (optional)
package_name: str = 'package_name_example' # Filter events by the Package Name (Android) associated with the event.  (optional)
origin: str = 'origin_example' # Filter events by the origin field of the event. This is applicable to web events only (e.g., https://example.com)  (optional)
start: int = 56 # Filter events with a timestamp greater than the start time, in Unix time (milliseconds).  (optional)
end: int = 56 # Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).  (optional)
reverse: bool = True # Sort events in reverse timestamp order.  (optional)
suspect: bool = True # 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.  (optional)
vpn: bool = True # 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.  (optional)
virtual_machine: bool = True # 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.  (optional)
tampering: bool = True # 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.  (optional)
anti_detect_browser: bool = True # 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.  (optional)
incognito: bool = True # 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.  (optional)
privacy_settings: bool = True # 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.  (optional)
jailbroken: bool = True # 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.  (optional)
frida: bool = True # 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.  (optional)
factory_reset: bool = True # 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.  (optional)
cloned_app: bool = True # 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.  (optional)
emulator: bool = True # 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.  (optional)
root_apps: bool = True # 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.  (optional)
vpn_confidence: SearchEventsVpnConfidence = fingerprint_server_sdk.SearchEventsVpnConfidence() # 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.  (optional)
min_suspect_score: float = 3.4 # 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.  (optional)
developer_tools: bool = True # 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.  (optional)
location_spoofing: bool = True # 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.  (optional)
mitm_attack: bool = True # 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.  (optional)
proxy: bool = True # 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.  (optional)
sdk_version: str = 'sdk_version_example' # Filter events by a specific SDK version associated with the identification event (`sdk.version` property). Example: `3.11.14`  (optional)
sdk_platform: SearchEventsSdkPlatform = fingerprint_server_sdk.SearchEventsSdkPlatform() # 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.  (optional)
environment: List[str] = ['environment_example'] # Filter for events by providing one or more environment IDs (`environment_id` property).  (optional)
proximity_id: str = 'proximity_id_example' # 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.  (optional)
total_hits: int = 56 # 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.  (optional)
tor_node: bool = True # 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.  (optional)

try:
    # Search events
    api_response = api_instance.search_events(limit=limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, asn=asn, linked_id=linked_id, url=url, bundle_id=bundle_id, package_name=package_name, origin=origin, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, total_hits=total_hits, tor_node=tor_node)
    print("The response of FingerprintApi->search_events:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling FingerprintApi->search_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Limit the number of events returned.	[optional] [default to 10]
pagination_key	str	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`	[optional]
visitor_id	str	Unique visitor identifier issued by Fingerprint Identification and all active Smart Signals. Filter for events matching this `visitor_id`.	[optional]
bot	SearchEventsBot	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.	[optional]
ip_address	str	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	[optional]
asn	str	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.
linked_id	str	Filter events by your custom identifier. You can use linked Ids 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.	[optional]
url	str	Filter events by the URL (`url` property) associated with the event.	[optional]
bundle_id	str	Filter events by the Bundle ID (iOS) associated with the event.	[optional]
package_name	str	Filter events by the Package Name (Android) associated with the event.	[optional]
origin	str	Filter events by the origin field of the event. This is applicable to web events only (e.g., https://example.com)	[optional]
start	int	Filter events with a timestamp greater than the start time, in Unix time (milliseconds).	[optional]
end	int	Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).	[optional]
reverse	bool	Sort events in reverse timestamp order.	[optional]
suspect	bool	Filter events previously tagged as suspicious via the Update API. > 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.	[optional]
vpn	bool	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.	[optional]
virtual_machine	bool	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.	[optional]
tampering	bool	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.	[optional]
anti_detect_browser	bool	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.	[optional]
incognito	bool	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.	[optional]
privacy_settings	bool	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.	[optional]
jailbroken	bool	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.	[optional]
frida	bool	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.	[optional]
factory_reset	bool	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.	[optional]
cloned_app	bool	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.	[optional]
emulator	bool	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.	[optional]
root_apps	bool	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.	[optional]
vpn_confidence	SearchEventsVpnConfidence	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.	[optional]
min_suspect_score	float	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.	[optional]
developer_tools	bool	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.	[optional]
location_spoofing	bool	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.	[optional]
mitm_attack	bool	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.	[optional]
proxy	bool	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.	[optional]
sdk_version	str	Filter events by a specific SDK version associated with the identification event (`sdk.version` property). Example: `3.11.14`	[optional]
sdk_platform	SearchEventsSdkPlatform	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.	[optional]
environment	List[str]	Filter for events by providing one or more environment IDs (`environment_id` property).	[optional]
proximity_id	str	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.	[optional]
total_hits	int	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.	[optional]
tor_node	bool	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.	[optional]

Return type

EventSearch

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Events matching the filter(s).	-
400	Bad request. One or more supplied search parameters are invalid, or a required parameter is missing.	-
403	Forbidden. Access to this API is denied.	-
500	Workspace error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_event

update_event(event_id, event_update)

Update an event

Change information in existing events specified by event_id or flag suspicious events.

When an event is created, it can be assigned linked_id and tags submitted through the JS agent parameters. This information might not have been available on the client initially, so the Server API permits updating these attributes after the fact.

Warning It's not possible to update events older than one month.

Warning Trying to update an event immediately after creation may temporarily result in an error (HTTP 409 Conflict. The event is not mutable yet.) as the event is fully propagated across our systems. In such a case, simply retry the request.

Example

import os

import fingerprint_server_sdk
from fingerprint_server_sdk.models.event_update import EventUpdate
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

# Configure API key authorization and region
configuration = fingerprint_server_sdk.Configuration(
    api_key = os.environ["SECRET_API_KEY"],
    region = Region.US
)

# Create an instance of the API class
api_instance = fingerprint_server_sdk.FingerprintApi(configuration)

event_id: str = 'event_id_example' # The unique event [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id).
event_update: EventUpdate = fingerprint_server_sdk.EventUpdate() # 

try:
    # Update an event
    api_instance.update_event(event_id, event_update)
except Exception as e:
    print("Exception when calling FingerprintApi->update_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_id	str	The unique event identifier.
event_update	EventUpdate

Return type

void (empty response body)

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK.	-
400	Bad request. The request payload is not valid.	-
403	Forbidden. Access to this API is denied.	-
404	Not found. The event Id cannot be found in this workspace's data.	-
409	Conflict. The event is not mutable yet.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fingerprint_server_sdk.FingerprintApi

delete_visitor_data

Which data is deleted?

Browser (or device) properties

Identification requests made from this browser (or device)

Corollary

Interested?

Example

Parameters

Return type

HTTP request headers

HTTP response details

get_event

Example

Parameters

Return type

HTTP request headers

HTTP response details

search_events

Search

Filtering events with the `suspect` flag

Environment scoping

Example

Parameters

Return type

HTTP request headers

HTTP response details

update_event

Example

Parameters

Return type

HTTP request headers

HTTP response details

FilesExpand file tree

FingerprintApi.md

Latest commit

History

FingerprintApi.md

File metadata and controls

fingerprint_server_sdk.FingerprintApi

delete_visitor_data

Which data is deleted?

Browser (or device) properties

Identification requests made from this browser (or device)

Corollary

Interested?

Example

Parameters

Return type

HTTP request headers

HTTP response details

get_event

Example

Parameters

Return type

HTTP request headers

HTTP response details

search_events

Search

Filtering events with the suspect flag

Environment scoping

Example

Parameters

Return type

HTTP request headers

HTTP response details

update_event

Example

Parameters

Return type

HTTP request headers

HTTP response details

Filtering events with the `suspect` flag