Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PLAT-786: Add event search API to spec #173

Merged
merged 15 commits into from
Nov 19, 2024
Merged

PLAT-786: Add event search API to spec #173

merged 15 commits into from
Nov 19, 2024

Conversation

srri
Copy link
Contributor

@srri srri commented Nov 8, 2024

This PR adds the API definition for the new event search API https://github.com/fingerprintjs/koala/pull/7030
This is a public facing API that will return a list of the existing APIv3 event format.

This API can filter on visitor id, ip address/range, suspect flag, bot type, time ranges, and linked id.

This is also my first change directly to our open API repo, so let me know if I missed something (for example, a version bump)

cc: @petrpalata

Copy link

changeset-bot bot commented Nov 8, 2024

🦋 Changeset detected

Latest commit: 2f1cfb7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
fingerprint-pro-server-api-openapi Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@srri
Copy link
Contributor Author

srri commented Nov 8, 2024

I'm sure I've probably missed something, but setting for review.

@srri srri marked this pull request as ready for review November 8, 2024 22:38
@ilfa
Copy link
Member

ilfa commented Nov 14, 2024

@srri could you add release notes to this PR as described here?

schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/components/schemas/SearchEventsResponse.yaml Outdated Show resolved Hide resolved
schemas/components/schemas/Identification.yaml Outdated Show resolved Hide resolved
schemas/components/schemas/SearchEventsResponse.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
schemas/paths/event-search.yaml Outdated Show resolved Hide resolved
Co-authored-by: Juraj Uhlar <[email protected]>
JuroUhlar
JuroUhlar previously approved these changes Nov 19, 2024
JuroUhlar
JuroUhlar previously approved these changes Nov 19, 2024
Copy link
Contributor

🚀 Following releases will be created using changesets from this PR:

[email protected]

Minor Changes

  • events-search: Add a new events/search API endpoint. Allow users to search for identification events matching one or more search criteria, for example, visitor ID, IP address, bot detection result, etc. (3634610)
  • events: Add a suspect field to the identification product schema (3634610)

@ilfa ilfa merged commit dea4845 into main Nov 19, 2024
2 checks passed
@ilfa ilfa deleted the PLAT-786/search-api branch November 19, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants