Fingerprint

Get events via search

🚧 Deprecation Notice

This version of Server API is marked as deprecated starting on Jan 7th 2026 according to our API Deprecation Policy. If you still use this version, please follow our migration guide to migrate from this deprecated version to the new one.

Search for identification events, including Smart Signals, using multiple filtering criteria. If you don't provide start or end parameters, the default search range is the last 7 days.

Please note that events include mobile signals (e.g. rootApps) even if the request originated from a non-mobile platform. We recommend you ignore mobile signals for such requests.

get/events/search

Request

  • Base URL: https://api.fpjs.io
  • URL: https://api.fpjs.io/events/search
  • Auth: one of:
    • API key in header Auth-API-Key
    • API key in query parameter api_key

Query parameters

limitinteger required
Example:10

Limit the number of events returned.

pagination_keystring

Use pagination_key to get the next page of results.

When more results are available (e.g., you requested up to 200 results for your search using limit, but there are more than 200 events total matching your request), the paginationKey top-level attribute is added to the response. The key corresponds to the timestamp of the last returned event. 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/search?limit=200
  2. Use response.paginationKey to get the next page of results: GET api-base-url/events/search?limit=200&pagination_key=1740815825085
visitor_idstring

Unique visitor identifier issued by Fingerprint Identification and all active Smart Signals. Filter for events matching this visitor_id.

bot'all' | 'good' | 'bad' | 'none'

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 products.botd.data.bot.result property set to a valid value are returned. Events without a products.botd Smart Signal result are left out of the response.

ip_addressstring

Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32

linked_idstring

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.

startinteger

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

endinteger

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

reverseboolean

When true, sort events oldest first (ascending timestamp order). Default is newest first (descending timestamp order).

suspectboolean

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.

vpnboolean

Filter events by VPN Detection result.

Note: When using this parameter, only events with the products.vpn.data.result property set to true or false are returned. Events without a products.vpn Smart Signal result are left out of the response.

virtual_machineboolean

Filter events by Virtual Machine Detection result.

Note: When using this parameter, only events with the products.virtualMachine.data.result property set to true or false are returned. Events without a products.virtualMachine Smart Signal result are left out of the response.

tamperingboolean

Filter events by Tampering Detection result.

Note: When using this parameter, only events with the products.tampering.data.result property set to true or false are returned. Events without a products.tampering Smart Signal result are left out of the response.

anti_detect_browserboolean

Filter events by Anti-detect Browser Detection result.

Note: When using this parameter, only events with the products.tampering.data.antiDetectBrowser property set to true or false are returned. Events without a products.tampering Smart Signal result are left out of the response.

incognitoboolean

Filter events by Browser Incognito Detection result.

Note: When using this parameter, only events with the products.incognito.data.result property set to true or false are returned. Events without a products.incognito Smart Signal result are left out of the response.

privacy_settingsboolean

Filter events by Privacy Settings Detection result.

Note: When using this parameter, only events with the products.privacySettings.data.result property set to true or false are returned. Events without a products.privacySettings Smart Signal result are left out of the response.

jailbrokenboolean

Filter events by Jailbroken Device Detection result.

Note: When using this parameter, only events with the products.jailbroken.data.result property set to true or false are returned. Events without a products.jailbroken Smart Signal result are left out of the response.

fridaboolean

Filter events by Frida Detection result.

Note: When using this parameter, only events with the products.frida.data.result property set to true or false are returned. Events without a products.frida Smart Signal result are left out of the response.

factory_resetboolean

Filter events by Factory Reset Detection result.

Note: When using this parameter, only events with the products.factoryReset.data.result property set to true or false are returned. Events without a products.factoryReset Smart Signal result are left out of the response.

cloned_appboolean

Filter events by Cloned App Detection result.

Note: When using this parameter, only events with the products.clonedApp.data.result property set to true or false are returned. Events without a products.clonedApp Smart Signal result are left out of the response.

emulatorboolean

Filter events by Android Emulator Detection result.

Note: When using this parameter, only events with the products.emulator.data.result property set to true or false are returned. Events without a products.emulator Smart Signal result are left out of the response.

root_appsboolean

Filter events by Rooted Device Detection result.

Note: When using this parameter, only events with the products.rootApps.data.result property set to true or false are returned. Events without a products.rootApps Smart Signal result are left out of the response.

vpn_confidence'high' | 'medium' | 'low'

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 products.vpn.data.confidence property set to a valid value are returned. Events without a products.vpn Smart Signal result are left out of the response.

min_suspect_scorenumber float

Filter events with Suspect Score result above a provided minimum threshold.

Note: When using this parameter, only events where the products.suspectScore.data.result property set to a value exceeding your threshold are returned. Events without a products.suspectScore Smart Signal result are left out of the response.

ip_blocklistboolean

Filter events by IP Blocklist Detection result.

Note: When using this parameter, only events with the products.ipBlocklist.data.result property set to true or false are returned. Events without a products.ipBlocklist Smart Signal result are left out of the response.

datacenterboolean

Filter events by Datacenter Detection result.

Note: When using this parameter, only events with the products.ipInfo.data.v4.datacenter.result or products.ipInfo.data.v6.datacenter.result property set to true or false are returned. Events without a products.ipInfo Smart Signal result are left out of the response.

developer_toolsboolean

Filter events by Developer Tools detection result.

Note: When using this parameter, only events with the products.developerTools.data.result property set to true or false are returned. Events without a products.developerTools Smart Signal result are left out of the response.

location_spoofingboolean

Filter events by Location Spoofing detection result.

Note: When using this parameter, only events with the products.locationSpoofing.data.result property set to true or false are returned. Events without a products.locationSpoofing Smart Signal result are left out of the response.

mitm_attackboolean

Filter events by MITM (Man-in-the-Middle) Attack detection result.

Note: When using this parameter, only events with the products.mitmAttack.data.result property set to true or false are returned. Events without a products.mitmAttack Smart Signal result are left out of the response.

rare_deviceboolean

Filter events by Rare Device detection result.

Note: When using this parameter, only events with the products.rareDevice.data.result property set to true or false are returned. Events without a products.rareDevice Smart Signal result are left out of the response.

rare_device_percentile_bucket'<p95' | 'p95-p99' | 'p99-p99.5' | 'p99.5-p99.9' | 'p99.9+' | 'not_seen'

Filter events by Rare Device 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.

proxyboolean

Filter events by Proxy detection result.

Note: When using this parameter, only events with the products.proxy.data.result property set to true or false are returned. Events without a products.proxy Smart Signal result are left out of the response.

sdk_versionstring

Filter events by a specific SDK version associated with the identification event. Example: 3.11.14

sdk_platform'js' | 'android' | 'ios'

Filter events by the SDK Platform associated with the identification event. js - JavaScript agent (Web). ios - Apple iOS based devices. android - Android based devices.

environmentstring[]

Filter for events by providing one or more environment IDs.

proximity_idstring

Filter events by the most precise Proximity ID provided by default.

Note: When using this parameter, only events with the products.proximity.id property matching the provided ID are returned. Events without a products.proximity result are left out of the response.

proximity_precision_radius10 | 25 | 65 | 175 | 450 | 1200 | 3300 | 8500 | 22500

Filter events by Proximity Radius.

Note: When using this parameter, only events with the products.proximity.precisionRadius property set to a valid value are returned. Events without a products.proximity result are left out of the response.

Response

Events matching the filter(s).

paginationKeystring

Use this value in the pagination_key parameter to request the next page of search results.

Changes

No recorded changes to this operation across all 1 revision of this API.