fingerlydocs
fingerly.io Log inDashboard
API reference

List events

List identification events in a time window, newest first, filtered by visitor or suspect level.

GET/api/v1/events Secret key

Returns events from the secret key's own organization and environment, newest first. The window can reach back 30 days.

Try it

Sends this request from your browser to Fingerly. Development secret keys only, and the key is not stored.

GET https://us.api.fingerly.io/api/v1/events

Query parameters

  • fromstringDefault 24 hours ago
    Start of the window, inclusive, RFC 3339.
  • tostringDefault now
    End of the window, exclusive, RFC 3339.
  • pageintegerDefault 1
    One-based page number. The offset may not exceed 10,000 events.
  • limitintegerDefault 10
    Events per page, at most 200.
  • visitorstring
    Only events for this exact visitor ID.
  • levelstring
    Only events at low, medium or high.

from must be before to, the window may span at most 30 days, and it may not start more than 30 days ago. Otherwise the request fails with 422 invalid_window.

Response

  • rowsarray
    The events on this page. Each has the event fields.
  • pageinteger
    This page's number.
  • page_sizeinteger
    The page size applied.

There is no total count. A page with fewer rows than page_size is the last one.

Errors

StatusCodeWhen
401unauthorizedThe key is not a valid secret key.
422invalid_windowThe window, page offset, level or visitor filter is not valid.
422validation_errorA parameter has the wrong type.

Last updated