All URIs are relative to https://api.fpjs.io
| Method | HTTP request | Description |
|---|---|---|
| GetEvent | Get /events/{request_id} | Get event by requestId |
| GetVisits | Get /visitors/{visitor_id} | Get visits by visitorId |
EventResponse GetEvent(ctx, requestId) Get event by requestId
This endpoint allows you to get a detailed analysis of an individual request. Only for Enterprise customers: Please note that the response includes mobile signals (e.g. rootApps) even if the request originated from a non-mobile platform. It is highly recommended that you ignore the mobile signals for such requests. Use requestId as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by requestId.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| requestId | string | The unique identifier of each analysis request. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response GetVisits(ctx, visitorId, optional) Get visits by visitorId
This endpoint allows you to get a history of visits for a specific visitorId. Use the visitorId as a URL path parameter. Only information from the Identification product is returned. #### Headers * Retry-After — Present in case of 429 Too many requests. Indicates how long you should wait before making a follow-up request. The value is non-negative decimal integer indicating the seconds to delay after the response is received.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| visitorId | string | Unique identifier of the visitor issued by Fingerprint Pro. |
Optional parameters are passed through a pointer to a FingerprintApiGetVisitsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| requestId | optional.String | Filter visits by requestId. Every identification request has a unique identifier associated with it called requestId. This identifier is returned to the client in the identification result. When you filter visits by requestId, only one visit will be returned. |
|
| linkedId | optional.String | Filter visits by your custom identifier. You can use 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. |
|
| limit | optional.Int32 | Limit scanned results. For performance reasons, the API first scans some number of events before filtering them. Use limit to specify how many events are scanned before they are filtered by requestId or linkedId. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500. |
|
| paginationKey | optional.String | Use paginationKey to get the next page of results. When more results are available (e.g., you requested 200 results using limit parameter, but a total of 600 results are available), the paginationKey top-level attribute is added to the response. The key corresponds to the requestId of the last returned event. In the following request, use that value in the paginationKey parameter to get the next page of results: 1. First request, returning most recent 200 events: GET api-base-url/visitors/:visitorId?limit=200 2. Use response.paginationKey to get the next page of results: GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j Pagination happens during scanning and before filtering, so you can get less visits than the limit you specified with more available on the next page. When there are no more results available for scanning, the paginationKey attribute is not returned. |
|
| before | optional.Int64 | paginationKey instead. Timestamp (in milliseconds since epoch) used to paginate results. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]