events
Retrieves a detailed, paginated list of all requests processed by BotBye for a specific project. This endpoint provides comprehensive request-level data including headers, IP addresses, security check results, and decision outcomes, enabling deep forensic analysis and debugging.
Endpoint
Authentication
Requires API key authentication:
Path Parameters
Query Parameters
This endpoint supports pagination and filtering parameters:
-
Pagination: See
Pagination query parametersfor details onfirst,after,last,beforeparameters -
Filtering: Additional filters may be available for date ranges, request status, IP addresses, etc.
Response Structure
The response follows a cursor-based pagination pattern. Every field of a record is nullable except
signalsHiddenByPlan: a record carries only what the integration reported and what the validator
resolved for it, and the key is present with null otherwise.
Response Fields
edges (array): Contains the request records
-
cursor (string): Pagination cursor for this record
-
node (object): The request data with the following fields:
Accepted permissions
Project → Events → EventsToken scope
Request View
Authentication
Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.
Path parameters
Query parameters
(Optional): a cursor for pagination.
after(string): Pointer to the item after which the items are to be retrieved.before(string): Pointer to the item before which the items are to be retrieved.
(Optional): is used to create conditions for data filtering. It can be used to create simple conditions (leaf nodes) as well as compound logical expressions (branch nodes).
predicate(string): The filtering condition (e.g.,gte,lte,eqfor a leaf orand,orfor a branch). Possible values [[#Predicate]]opearands(string): A list of nested conditions (used only for branches, such asand,or).fieldPath(string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).value(string): The value to compare against the field (used only for a leaf).
(Optional): property by which to order by.
fieldPath(string): name of order field.direction(string):ASCorDESC
(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100.