visitorId. Use the visitorId as a URL path parameter. Only information from the Identification product is returned.
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.Unique visitor identifier issued by Fingerprint Identification and all active Smart Signals.
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 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.
x >= 0Use 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:
GET api-base-url/visitors/:visitorId?limit=200response.paginationKey to get the next page of results: GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1jPagination 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.
⚠️ Deprecated pagination method, please use paginationKey instead. Timestamp (in milliseconds since epoch) used to paginate results.
x >= 0OK.
Pagination-related fields lastTimestamp and paginationKey are included if you use a pagination parameter like limit or before and there is more data available on the next page.
⚠️ Deprecated paging attribute, please use paginationKey instead. Timestamp of the last visit in the current page of results.
Request ID of the last visit in the current page of results. Use this value in the following request as the paginationKey parameter to get the next page of results.