{"info":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","description":"

API for managing BotBye projects: supports CRUD operations on Projects, Custom Rules, Rate Limiters, and Requests.

This API is designed for managing projects within BotBye accounts. It provides a full set of CRUD operations for projects and associated resources, such as Custom Rules, Rate Limiters, Request Overview, and Requests. The API is aimed at developers, businesses, and anyone interested in integrating BotBye capabilities into their solutions.

🧭 Functionality:

Manage projects within BotBye accounts.
Create, update, delete, and retrieve information about Custom Rules.
Configure and manage Rate Limiters.
Monitor and analyze requests through Request Overview and Requests.

🌐 Technologies:

This API is built on REST architecture, ensuring easy integration and scalability.

🛠️ Use Cases:

Integration with partner applications and platforms to extend functionality.
Building custom solutions and products based on BotBye's API.
Expanding your product line using the data and capabilities provided by the API.

🔐 Additional Information:

Access to the API requires authorization via an API token, which can be generated within your BotBye account.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25726021","collectionId":"dfffe03f-e114-41dc-8949-f764f2aa0135","publishedId":"2sAXjNWqV1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-27T12:15:57.000Z"},"item":[{"name":"Projects","item":[{"name":"find all","event":[{"listen":"test","script":{"id":"1c46b9c5-eae2-48d2-ac00-51117d9562ba","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json().edges[0].node.id;","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{}}}],"id":"28045ce1-7828-456b-87e7-f86d607aab91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects","description":"

This endpoint makes an HTTP GET request to retrieve a list of projects associated with the specified account. The response is in JSON format and varies based on the available projects.

Request

No request body parameters are required for this endpoint.

Path Parameters:

account_id (string): The unique identifier of the account.

Query Parameters:

see Pagination query parameters

The response schema for this request can be documented as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"edges\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"cursor\": { \"type\": \"string\" },\n          \"node\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": { \"type\": \"string\" },\n              \"customerId\": { \"type\": \"string\" },\n              \"name\": { \"type\": \"string\" },\n              \"url\": { \"type\": \"string\" },\n              \"siteKey\": { \"type\": \"string\" },\n              \"serverKey\": { \"type\": \"string\" },\n              \"isProtected\": { \"type\": \"boolean\" },\n              \"rules\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"order\": { \"type\": \"array\" },\n                  \"rules\": { \"type\": \"array\" }\n                }\n              },\n              \"rateLimits\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"order\": { \"type\": \"array\" },\n                  \"rateLimits\": { \"type\": \"array\" }\n                }\n              },\n              \"phishingInfo\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"originalUrl\": { \"type\": \"string\" },\n                  \"action\": { \"type\": \"string\" },\n                  \"allowedUrls\": { \"type\": \"array\" }\n                }\n              },\n              \"responseExtraFields\": { \"type\": \"array\" },\n              \"updatedAt\": { \"type\": \"string\" },\n              \"createdAt\": { \"type\": \"string\" }\n            }\n          }\n        }\n      }\n    },\n    \"pageInfo\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"hasPreviousPage\": { \"type\": \"boolean\" },\n        \"hasNextPage\": { \"type\": \"boolean\" },\n        \"startCursor\": { \"type\": [\"string\", \"null\"] },\n        \"endCursor\": { \"type\": [\"string\", \"null\"] },\n        \"total\": { \"type\": \"integer\" }\n      }\n    },\n    \"attributes\": { \"type\": \"object\" }\n  }\n}\n\n

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

(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).\n - predicate (string): The filtering condition (e.g., gte, lte, eq for a leaf or and, or for a branch). Possible values [[#Predicate]]\n - opearands (string): A list of nested conditions (used only for branches, such as and, or).\n - fieldPath (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).\n - value (string): The value to compare against the field (used only for a leaf).

\n","type":"text/plain"},"key":"where","value":""},{"disabled":true,"description":{"content":"

(Optional): property by which to order by.\n - fieldPath (string): name of order field.\n - direction (string): ASC or DESC

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100.

\n","type":"text/plain"},"key":"limit","value":null}],"variable":[]}},"response":[{"id":"2cac3e8b-1a3a-4a4a-b81a-71ec8ac44f0c","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1859"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjUzMTIwMDAwMCJdXQ==\",\n \"node\": {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Nemiga\",\n \"url\": \"https://nemiga.org\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"https://nemiga.org\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1672531200000\",\n \"createdAt\": \"1672531200000\"\n }\n },\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ==\",\n \"node\": {\n \"id\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Varka\",\n \"url\": \"https://varka.org\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"https://varka.org\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1672617600000\",\n \"createdAt\": \"1672617600000\"\n }\n },\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTcyNDE2MDI0MTg2NCJdXQ==\",\n \"node\": {\n \"id\": \"01916ff5-70c8-7f01-a0c3-701d23966866\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"test\",\n \"url\": \"http://test.com\",\n \"siteKey\": \"01916ff5-70c8-7f01-a0c4-5a03fd5b3969\",\n \"serverKey\": \"01916ff5-70c8-7f01-a0c5-df33dc41009d\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"http://test.com\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1724160241864\",\n \"createdAt\": \"1724160241864\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": false,\n \"startCursor\": null,\n \"endCursor\": null,\n \"total\": 3\n },\n \"attributes\": {}\n}"},{"id":"425ac9d6-a321-4bbe-a784-467a4119c1c6","name":"fail","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"265"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Access denied to perform operation for customer with id = 'c415a474-be24-11eb-8529-0242ac130003'.\",\n \"code\": \"protectioncustomers.access_denied_to_perform_operation_error\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\"\n }\n }\n]"},{"id":"ec9ec691-872f-4ead-a4bc-3a3bea5d1788","name":"where example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects?where=%7B%22fieldPath%22%3A%22project__url%22%2C%22predicate%22%3A%22like%22%2C%22value%22%3A%22http%22%7D","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects"],"query":[{"key":"where","value":"%7B%22fieldPath%22%3A%22project__url%22%2C%22predicate%22%3A%22like%22%2C%22value%22%3A%22http%22%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1340"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjUzMTIwMDAwMCJdXQ==\",\n \"node\": {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Nemiga\",\n \"url\": \"https://nemiga.org\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"https://nemiga.org\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1672531200000\",\n \"createdAt\": \"1672531200000\"\n }\n },\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ==\",\n \"node\": {\n \"id\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Varka\",\n \"url\": \"https://varka.org\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"https://varka.org\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1672617600000\",\n \"createdAt\": \"1672617600000\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": true,\n \"startCursor\": null,\n \"endCursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ==\",\n \"total\": 3\n },\n \"attributes\": {}\n}"},{"id":"3d3ff60f-19ad-4da6-b327-3509529734fe","name":"cursor example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects?cursor=%7B%22first%22%3A2%2C%20%22after%22%3A%22W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ%3D%3D%22%7D","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects"],"query":[{"key":"cursor","value":"%7B%22first%22%3A2%2C%20%22after%22%3A%22W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ%3D%3D%22%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"755"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTcyNDE2MDI0MTg2NCJdXQ==\",\n \"node\": {\n \"id\": \"01916ff5-70c8-7f01-a0c3-701d23966866\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"test\",\n \"url\": \"http://test.com\",\n \"siteKey\": \"01916ff5-70c8-7f01-a0c4-5a03fd5b3969\",\n \"serverKey\": \"01916ff5-70c8-7f01-a0c5-df33dc41009d\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"http://test.com\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1724160241864\",\n \"createdAt\": \"1724160241864\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": true,\n \"hasNextPage\": false,\n \"startCursor\": \"W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTcyNDE2MDI0MTg2NCJdXQ==\",\n \"endCursor\": null,\n \"total\": 3\n },\n \"attributes\": {}\n}"}],"_postman_id":"28045ce1-7828-456b-87e7-f86d607aab91"},{"name":"find","id":"02d0dbe5-1127-440f-9f54-b66e47c6bf6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}","description":"

GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"bd1140f9-0d11-4bcf-99f0-e4b56f1814aa","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"494"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"01916ff5-70c8-7f01-a0c3-701d23966866\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"test\",\n \"url\": \"http://test.com\",\n \"siteKey\": \"01916ff5-70c8-7f01-a0c4-5a03fd5b3969\",\n \"serverKey\": \"01916ff5-70c8-7f01-a0c5-df33dc41009d\",\n \"isProtected\": false,\n \"rules\": {\n \"order\": [],\n \"rules\": []\n },\n \"rateLimits\": {\n \"order\": [],\n \"rateLimits\": []\n },\n \"phishingInfo\": {\n \"originalUrl\": \"http://test.com\",\n \"action\": \"IGNORE\",\n \"allowedUrls\": []\n },\n \"responseExtraFields\": [],\n \"updatedAt\": \"1724160241864\",\n \"createdAt\": \"1724160241864\"\n}"},{"id":"afce71ba-fe32-4935-ab83-f52f18de64a5","name":"fail","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/231231231231"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Invalid path param 'project_id'. Should be type of 'UUID'.\",\n \"code\": \"protectionapifacade.invalidPathParam\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"param\": \"project_id\",\n \"type\": \"UUID\"\n }\n }\n]"}],"_postman_id":"02d0dbe5-1127-440f-9f54-b66e47c6bf6e"},{"name":"create","event":[{"listen":"test","script":{"id":"48f83dd6-c1f0-480d-9b8a-7ed9e34de1e3","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json();","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"248c8829-a984-4011-bf80-031061a1a0a7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9ea3db7e-290d-426a-b703-4a2890cb91cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Intelligent Plastic Car\",\n \"url\": \"http://jerad.info\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects","description":"

GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"3b5f6491-6120-4a1f-8520-f4897d8f4f59","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Mars\",\n \"url\": \"http://mars.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"38"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\"019199a4-778f-7853-ac3b-6e6c5f13bc3b\""},{"id":"6771e974-264e-4de6-8791-571f3c8c7ba1","name":"fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Mars\",\n \"url\": \"http://mars.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"261"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Customer with id = 'c415a474-be24-11eb-8529-0242ac130003' already created project with name = 'Mars'.\",\n \"code\": \"protectionproject.projectAlreadyExists\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Mars\"\n }\n }\n]"}],"_postman_id":"9ea3db7e-290d-426a-b703-4a2890cb91cf"},{"name":"partial update","id":"15587196-d0b8-4051-88a5-f326fe2ea3f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"isProtected\": true,\n \"name\": \"Ergonomic Frozen Shoes\",\n \"url\": \"https://porter.info\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}","description":"

GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

This folder contains requests related to project management. It includes operations for creating, retrieving, updating, and deleting projects within the system.

\n","_postman_id":"d77bb8b6-32de-4e43-ab3d-3d8a6ed9dc73","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Rate limiters","item":[{"name":"find","id":"5603acc9-eb2f-4070-974c-ed8d11189713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}","description":"

GET /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

This endpoint retrieves rate limiter details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
\n
account_id (string): The unique identifier of the account.
\n
project_id (string): The unique identifier of the project.
\n
rate_limiter_id (string): The unique identifier of the rate limiter.
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"limit\": 0,\n  \"periodInSec\": 0,\n  \"name\": \"\",\n  \"action\": \"\",\n  \"isActive\": true,\n  \"condition\": \"\"\n}\n\n

id (string): The unique identifier of the rate limiter.
\n
limit (number): The limit of the rate limiter.
\n
periodInSec (number): The period in seconds for the rate limiter.
\n
name (string): The name of the rate limiter.
\n
action (string): The action of the rate limiter.
\n
isActive (boolean): Indicates whether the rate limiter is active.
\n
condition (string): The condition of the rate limiter.
\n

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rate_limiters","{rate_limiter_id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"79b53c22-bfa7-4e21-848f-218fc76ae185","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"251"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"01919a18-c6dc-7036-bb4e-d6d53c3587b5\",\n \"limit\": 888,\n \"periodInSec\": 5,\n \"name\": \"Tasty Soft Cheese\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": \"{\\\"fieldName\\\":\\\"remote_addr\\\",\\\"predicate\\\":\\\"EQ\\\",\\\"value\\\":\\\"232.3.158.185\\\",\\\"type\\\":\\\"criteria\\\"}\"\n}"}],"_postman_id":"5603acc9-eb2f-4070-974c-ed8d11189713"},{"name":"delete","id":"31494452-8118-43bd-ae4c-01e825920099","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}","description":"

DELETE /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

This endpoint is used to delete a specific rate limiter within a project in an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
\n
account_id (string): The unique identifier of the account.
\n
project_id (string): The unique identifier of the project.
\n
rate_limiter_id (string): The unique identifier of the rate limiter to be deleted.
\n

Response

The response for this request is a JSON object with the following schema:

{}\n\n

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rate_limiters","{rate_limiter_id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"fb6dcbba-04db-4ee3-b464-bd87cedc1e91","name":"success","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"9fe919ef-4ac5-4efc-9d5b-e208f722f183","name":"fail","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"210"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Rate limiter'01919a16-ad41-7f31-ad01-845aeee50041' not found\",\n \"code\": \"protectionproject.projectRateLimiterNotFoundError\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"ids\": \"01919a16-ad41-7f31-ad01-845aeee50041\"\n }\n }\n]"}],"_postman_id":"31494452-8118-43bd-ae4c-01e825920099"},{"name":"update order","id":"48df0d89-3cdb-4d12-9aeb-ad39d187881c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"[\n \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"01919a18-c6dc-7036-bb4e-d6d53c3587b5\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/order","description":"

PATCH /api/v1/{account_id}/projects/{project_id}/rate_limiters/order

This endpoint is used to update the rate limiters order for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rate_limiters","order"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"0c78e96d-bba5-44ec-80dc-ebfaeeafba19","name":"success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"[\n \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"01919a18-c6dc-7036-bb4e-d6d53c3587b5\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"48df0d89-3cdb-4d12-9aeb-ad39d187881c"},{"name":"set isActive","id":"62c7bcfa-dd66-47b9-8a35-b78751beb758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"isActive\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active","description":"

PATCH /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active

This endpoint updates the active status of a rate limiter for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.
rate_limiter_id (string): The unique identifier of the rate limiter.

Request Body

isActive: (boolean) Indicates the new active status of the rule.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rate_limiters","{rate_limiter_id}","active"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"b14c14d4-1894-4cff-a516-589d31331c58","name":"success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"isActive\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"90bdf075-3554-4419-9f96-a8c11d7fedfc","name":"fail","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Internal Server Error\",\n \"code\": \"500 Internal Server Error\",\n \"type\": \"RUNTIME\",\n \"context\": null\n}"}],"_postman_id":"62c7bcfa-dd66-47b9-8a35-b78751beb758"},{"name":"update","id":"df16dae5-5a55-4c86-a9cd-f8cf077be083","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"limit\": 500,\n \"periodInSec\": 5,\n \"name\": \"Fantastic Cotton Hat\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"141.17.95.179\",\n \"type\": \"criteria\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters","description":"

PUT /api/v1/{account_id}/projects/{project_id}/rate_limiters

This endpoint updates the rate limiters for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rate_limiters"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"3977a199-1dad-4641-ab06-428fb17a56ba","name":"fail","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"limit\": 500,\n \"periodInSec\": 5,\n \"name\": \"Fantastic Cotton Hat\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": \"{\\\"fieldName\\\":\\\"remote_addr\\\",\\\"predicate\\\":\\\"EQ\\\",\\\"value\\\":\\\"141.17.95.179\\\",\\\"type\\\":\\\"criteria\\\"}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"102"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Internal Server Error\",\n \"code\": \"500 Internal Server Error\",\n \"type\": \"RUNTIME\",\n \"context\": null\n}"},{"id":"7e9e36f8-71b6-407d-8452-1b0ce371c10c","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"limit\": 500,\n \"periodInSec\": 5,\n \"name\": \"Fantastic Cotton Hat\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"141.17.95.179\",\n \"type\": \"criteria\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"df16dae5-5a55-4c86-a9cd-f8cf077be083"},{"name":"create","event":[{"listen":"prerequest","script":{"id":"3614d444-2953-4cf2-a688-4a41f8545b90","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"4c8830e9-4cb9-4962-9f6a-5e636a5ee1bf","exec":["var id = pm.response.json();","pm.collectionVariables.set(\"rate_limiter_id\", id);"],"type":"text/javascript","packages":{}}}],"id":"636e9226-36b1-4d44-a6fd-d1b48836a545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Ergonomic Steel Bike\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"13.221.242.5\",\n \"type\": \"criteria\"\n },\n \"periodInSec\": 5,\n \"limit\": 149\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rate_limiters","description":"

POST /api/v1/{account_id}/projects/{project_id}/rate_limiters

This endpoint is used to create a rate limiter for a specific project within an account.

Request

The request body should be in JSON format and include the following parameters:

name (string): The name of the rate limiter.
\n
action (string): The action to be taken when the rate limit is reached.
\n
isActive (boolean): Indicates whether the rate limiter is active.
\n
condition (object): An object containing the condition for the rate limiter, including fieldName, predicate, value, and type.
\n
periodInSec (integer): The time period in seconds for the rate limiter.
\n
limit (integer): The limit for the rate limiter.
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
\n
customerId (string): The unique identifier of the customer associated with the project.
\n
name (string): The name of the project.
\n
url (string): The URL of the project.
\n
siteKey (string): The site key of the project.
\n
serverKey (string): The server key of the project.
\n
isProtected (boolean): Indicates whether the project is protected.
\n
rules (object): An object containing order and rules arrays.
\n
rateLimits (object): An object containing order and rateLimits arrays.
\n
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
\n
responseExtraFields (array): An array of extra fields in the response.
\n
updatedAt (string): The timestamp when the project was last updated.
\n
createdAt (string): The timestamp when the project was created.
\n

Rate limiter is a mechanism that limits the frequency of certain operations or requests on a system to prevent resource overload, protect against attacks such as DDoS, and ensure fair bandwidth allocation among users

\n","_postman_id":"2f5cfee0-80c6-4428-be5a-811914e65179","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Custom rules","item":[{"name":"find","id":"301abf60-ce1c-4c7f-8f5f-1425e012df4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}","description":"

GET /api/v1/{account_id}/projects/{project_id}/rules/{rule_id}

This endpoint retrieves the details of a specific rule within a project.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
\n
account_id (string): The unique identifier of the account.
\n
project_id (string): The unique identifier of the project.
\n
rule_id (string): The unique identifier of the rule.
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"limit\": 0,\n  \"periodInSec\": 0,\n  \"name\": \"\",\n  \"action\": \"\",\n  \"isActive\": true,\n  \"condition\": \"\"\n}\n\n

id (string): The unique identifier of the rule.
\n
limit (number): The limit of the rule.
\n
periodInSec (number): The period in seconds for the rule.
\n
name (string): The name of the rule.
\n
action (string): The action associated with the rule.
\n
isActive (boolean): Indicates whether the rule is active.
\n
condition (string): The condition associated with the rule.
\n

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rules","{rule_id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"b0416f66-d55e-4279-9607-9ebe4de06db3","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"251"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"01919a18-c6dc-7036-bb4e-d6d53c3587b5\",\n \"limit\": 888,\n \"periodInSec\": 5,\n \"name\": \"Tasty Soft Cheese\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": \"{\\\"fieldName\\\":\\\"remote_addr\\\",\\\"predicate\\\":\\\"EQ\\\",\\\"value\\\":\\\"232.3.158.185\\\",\\\"type\\\":\\\"criteria\\\"}\"\n}"}],"_postman_id":"301abf60-ce1c-4c7f-8f5f-1425e012df4b"},{"name":"delete","id":"b601bbf5-45ee-40c9-9d9f-218f1a524c4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}","description":"

DELETE /api/v1/{account_id}/projects/{project_id}/rules/{rule_id}

This endpoint is used to delete a specific rule within a project of an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
\n
account_id (string): The unique identifier of the account.
\n
project_id (string): The unique identifier of the project.
\n
rule_id (string): The unique identifier of the rule to be deleted.
\n

Response

The response for this request is a JSON object with the following schema:

{}\n\n

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rules","{rule_id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"e908fb35-8095-44f0-bd5b-18f652739a1f","name":"success","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e1ef2e84-60b8-432e-873d-f81c8c2d909d","name":"fail","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Rule'01919cfb-b934-789a-ba43-b5d818f81fcc' not found\",\n \"code\": \"protectionproject.projectRuleNotFoundError\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"ids\": \"01919cfb-b934-789a-ba43-b5d818f81fcc\"\n }\n }\n]"}],"_postman_id":"b601bbf5-45ee-40c9-9d9f-218f1a524c4c"},{"name":"update order","id":"44044206-a0b4-43ac-bd37-96e9048cab35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"[\n \"01919cfb-b934-789a-ba43-b5d818f81fcc\",\n \"01919cfb-420b-751f-bb48-888ea155f392\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/order","description":"

PATCH /api/v1/{account_id}/projects/{project_id}/rules/order

This endpoint updates the order of rules for a specific project within an account.

Request

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{\n  \"id\": \"\",\n  \"customerId\": \"\",\n  \"name\": \"\",\n  \"url\": \"\",\n  \"siteKey\": \"\",\n  \"serverKey\": \"\",\n  \"isProtected\": true,\n  \"rules\": {\n    \"order\": [],\n    \"rules\": []\n  },\n  \"rateLimits\": {\n    \"order\": [],\n    \"rateLimits\": []\n  },\n  \"phishingInfo\": {\n    \"originalUrl\": \"\",\n    \"action\": \"\",\n    \"allowedUrls\": []\n  },\n  \"responseExtraFields\": [],\n  \"updatedAt\": \"\",\n  \"createdAt\": \"\"\n}\n\n

id (string): The unique identifier of the project.
customerId (string): The unique identifier of the customer associated with the project.
name (string): The name of the project.
url (string): The URL of the project.
siteKey (string): The site key of the project.
serverKey (string): The server key of the project.
isProtected (boolean): Indicates whether the project is protected.
rules (object): An object containing order and rules arrays.
rateLimits (object): An object containing order and rateLimits arrays.
phishingInfo (object): An object containing originalUrl, action, and allowedUrls arrays.
responseExtraFields (array): An array of extra fields in the response.
updatedAt (string): The timestamp when the project was last updated.
createdAt (string): The timestamp when the project was created.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rules","order"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"5a7750d6-26b6-4cdf-8f6e-827e2f17aa5f","name":"success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"[\n \"01919cfb-b934-789a-ba43-b5d818f81fcc\",\n \"01919cfb-420b-751f-bb48-888ea155f392\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"44044206-a0b4-43ac-bd37-96e9048cab35"},{"name":"set isActive","id":"6a08eb46-c2e9-462b-a762-b953d82f2d31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"isActive\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}/active","description":"

Update Rule Active Status

This endpoint allows the user to update the active status of a specific rule within a project. The HTTP PATCH request should be made to https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}/active.

Request

base_url (string): The base URL of the API.
\n
account_id (string): The unique identifier of the account.
\n
project_id (string): The unique identifier of the project.
\n
rule_id (string): The unique identifier of the rule.
\n

Request Body

isActive: (boolean) Indicates the new active status of the rule.

Response

The response will include the updated active status of the rule.

Example Response:

{\n    \"active\": true\n}\n\n

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rules","{rule_id}","active"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"c7a12fc6-9cd4-4989-80b3-fb0f7a222152","name":"success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"isActive\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}/active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"d9c5f042-8719-4243-a141-76ace7399960","name":"fail","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}/active"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Internal Server Error\",\n \"code\": \"500 Internal Server Error\",\n \"type\": \"RUNTIME\",\n \"context\": null\n}"}],"_postman_id":"6a08eb46-c2e9-462b-a762-b953d82f2d31"},{"name":"update","id":"f9000dbf-d269-444e-bc80-e89cf0f75b69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ebae09ec-7e32-4cbf-a911-96bfeca17df4\",\n \"name\": \"Incredible Granite Cheese\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"137.232.80.243\",\n \"type\": \"criteria\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules","description":"

Update Project Rules

This endpoint allows updating rules for a specific project within the account.

Request Body

id (string): A unique identifier for the rule.
name (string): The name of the rule.
action (string): The action to be performed by the rule (e.g., \"block\").
isActive (boolean): Indicates whether the rule is active.
condition (object): The condition under which the rule will be triggered.
- fieldName (string): The field name to be evaluated for the condition.
- predicate (string): The comparison predicate (e.g., \"EQ\" for equal).
- value (string): The value to be compared for the condition.
- type (string): The type of condition (e.g., \"criteria\").
\n

Response
The response will be an empty object upon successful update of the project rules.

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","rules"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"69b43989-6c81-4d05-82b3-746026dab768","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01919cfb-b934-789a-ba43-b5d818f81fcc\",\n \"name\": \"Handmade Steel2 Bacon\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"179.92.83.38\",\n \"type\": \"criteria\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"708a8fb5-a375-4180-9ab2-eba6323433a6","name":"fail","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01919a19-7009-7422-8b2c-4c6317c89faa\",\n \"limit\": 500,\n \"periodInSec\": 5,\n \"name\": \"Fantastic Cotton Hat\",\n \"action\": \"block\",\n \"isActive\": false,\n \"condition\": \"{\\\"fieldName\\\":\\\"remote_addr\\\",\\\"predicate\\\":\\\"EQ\\\",\\\"value\\\":\\\"141.17.95.179\\\",\\\"type\\\":\\\"criteria\\\"}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"102"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Internal Server Error\",\n \"code\": \"500 Internal Server Error\",\n \"type\": \"RUNTIME\",\n \"context\": null\n}"}],"_postman_id":"f9000dbf-d269-444e-bc80-e89cf0f75b69"},{"name":"create","event":[{"listen":"prerequest","script":{"id":"3614d444-2953-4cf2-a688-4a41f8545b90","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"4c8830e9-4cb9-4962-9f6a-5e636a5ee1bf","exec":["var id = pm.response.json();","pm.collectionVariables.set(\"rule_id\", id);"],"type":"text/javascript","packages":{}}}],"id":"b327719c-19a0-40f4-8727-d9fea68fe504","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Fantastic Metal Ball\",\n \"action\": \"block\",\n \"isActive\": true,\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"169.21.172.25\",\n \"type\": \"criteria\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/rules","description":"

Create Project Rule

This endpoint allows the user to create a new rule for a specific project within their account.

Request Body

name (string): The name of the rule.
action (string): The action to be performed by the rule (e.g., \"block\").
isActive (boolean): Indicates whether the rule is active or not.
condition (object): The condition that triggers the rule.
- fieldName (string): The field name to be evaluated.
- predicate (string): The comparison predicate (e.g., \"EQ\" for equal).
- value (string): The value to compare against.
- type (string): The type of condition (e.g., \"criteria\").
\n

Response

The response for this request is a JSON object representing the created rule. As per user's request, the JSON schema for the response is as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"action\": {\n      \"type\": \"string\"\n    },\n    \"isActive\": {\n      \"type\": \"boolean\"\n    },\n    \"condition\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"fieldName\": {\n          \"type\": \"string\"\n        },\n        \"predicate\": {\n          \"type\": \"string\"\n        },\n        \"value\": {\n          \"type\": \"string\"\n        },\n        \"type\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

Custom rules allow you to define how the defence will function by specifying criteria for blocking or allowing requests

\n","_postman_id":"4c7c968c-2e00-45d0-acce-e772ef78c3ec","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Overview","item":[{"name":"requests overview","id":"2e39e61e-d3e5-4ca3-9ce6-fa27948d54bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/requests","description":"

Get Requests Overview

Retrieves aggregated request statistics for a specific project over a given time period. This endpoint provides time-series data showing allowed and declined request counts, enabling you to monitor traffic patterns and security events.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/requests\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier for which to retrieve overview data

Query Parameters

This endpoint supports standard time-based filtering parameters to specify the date range and granularity of the data:

Time period filters - Specify start/end dates and aggregation level (hourly, daily, monthly)
See Pagination query parameters for additional options

Response Structure

The response returns an array of time-series data points, each containing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`day`	string	Date in `YYYY-MM-DD` format for the data point
`hour`	integer	Hour interval (0-23) for hourly aggregation
`id`	string	Unique identifier combining `projectId`, `day`, and `hour` (format: `projectId_day_hour`)
`projectId`	string	The project identifier
`customerId`	null	Always null for project-level data
`allowedReqCount`	integer	Number of requests that were allowed during this period
`declinedReqCount`	integer	Number of requests that were declined during this period
`total`	integer	Total requests (`allowedReqCount + declinedReqCount`)

Example Response

[\n  {\n    \"day\": \"2024-08-24\",\n    \"hour\": 0,\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-24_0\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"allowedReqCount\": 13941,\n    \"declinedReqCount\": 13853,\n    \"total\": 27794\n  },\n  {\n    \"day\": \"2024-08-24\",\n    \"hour\": 1,\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-24_1\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"allowedReqCount\": 15234,\n    \"declinedReqCount\": 12456,\n    \"total\": 27690\n  }\n]\n

Use Cases

Traffic Monitoring: Track overall request volume trends over time
Security Dashboard: Visualize allowed vs. declined request ratios
Capacity Planning: Understand peak traffic periods
Anomaly Detection: Identify unusual spikes in declined requests
Performance Reporting: Generate reports on API protection effectiveness
Trend Analysis: Compare traffic patterns across different time periods

Important Notes

Data granularity depends on the time range requested (hourly for short periods, daily/monthly for longer periods)
The customerId field is always null for project-level aggregations
Use the id field as a unique key when storing or processing this data
Historical data availability depends on your BotBye plan's retention policy

(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 1, meaning the current day (or month if interval_type = month).

\n","type":"text/plain"},"key":"interval","value":"1"},{"disabled":true,"description":{"content":"

(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.

\n","type":"text/plain"},"key":"interval_type","value":"DAY"}],"variable":[]}},"response":[{"id":"720597c0-ec49-424c-bf9a-c5368fa3429f","name":"fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/requests?interval_type=DAY","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","requests"],"query":[{"key":"interval","value":"0","description":"(Optional) Defines the interval for the overview in milliseconds. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered.","type":"text","disabled":true},{"key":"interval_type","value":"DAY","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"143"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Missing query param 'interval'.\",\n \"code\": \"protectionapifacade.missingQueryParam\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"param\": \"interval\"\n }\n }\n]"},{"id":"123af1d2-8856-4edd-a6cb-502b5e60756f","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/requests?interval=7&interval_type=DAY","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","requests"],"query":[{"key":"interval","value":"7","description":"(Optional) Defines the interval for the overview in milliseconds. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1519"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"day\": \"2024-08-24\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-24_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 13941,\n \"declinedReqCount\": 13853,\n \"total\": 27794\n },\n {\n \"day\": \"2024-08-25\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-25_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 10361,\n \"declinedReqCount\": 10103,\n \"total\": 20464\n },\n {\n \"day\": \"2024-08-26\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-26_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 9803,\n \"declinedReqCount\": 9830,\n \"total\": 19633\n },\n {\n \"day\": \"2024-08-27\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-27_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 6367,\n \"declinedReqCount\": 6216,\n \"total\": 12583\n },\n {\n \"day\": \"2024-08-28\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-28_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 7390,\n \"declinedReqCount\": 7544,\n \"total\": 14934\n },\n {\n \"day\": \"2024-08-29\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-29_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 4439,\n \"declinedReqCount\": 4277,\n \"total\": 8716\n },\n {\n \"day\": \"2024-08-30\",\n \"hour\": 0,\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-30_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"allowedReqCount\": 435,\n \"declinedReqCount\": 437,\n \"total\": 872\n }\n]"}],"_postman_id":"2e39e61e-d3e5-4ca3-9ce6-fa27948d54bd"},{"name":"declined requests count","id":"a4765a0d-b4b2-4a38-aa5e-dda5426372b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests/count","description":"

Get Declined Requests Count

Retrieves detailed metrics about declined requests for a specific project, including counts and trend analysis. This endpoint helps you understand the volume and patterns of blocked traffic, including custom rule violations and bot detection.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests/count\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier for which to retrieve declined request metrics

Query Parameters

This endpoint supports time-based filtering parameters to specify the date range for analysis:

Time period filters - Specify start/end dates for the analysis period
See Pagination query parameters for additional options

Response Structure

The response returns an object containing declined request metrics and trends:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier combining `projectId`, `day`, and `hour` (format: `projectId_day_hour`)
`projectId`	string	The project identifier
`customerId`	null	Always null for project-level data
`bannedReqCount`	integer	Number of requests declined by custom rules during this period
`bannedReqTrend`	float	Percentage change in declined requests compared to previous period (negative = decrease, positive = increase)
`botReqCount`	integer	Number of requests identified as bot traffic during this period
`botReqTrend`	float	Percentage change in bot requests compared to previous period

Example Response

{\n  \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-17_0\",\n  \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n  \"customerId\": null,\n  \"bannedReqCount\": 56298,\n  \"bannedReqTrend\": -63.75,\n  \"botReqCount\": 0,\n  \"botReqTrend\": 0\n}\n

Use Cases

Security Monitoring: Track the volume of blocked malicious requests
Trend Analysis: Identify increases or decreases in attack activity
Rule Effectiveness: Measure how many requests your custom rules are blocking
Bot Detection Metrics: Monitor automated bot traffic separately from rule-based blocks
Alert Configuration: Set up alerts when declined request trends spike
Security Reporting: Generate reports showing protection effectiveness over time

Understanding Trends

The trend values indicate percentage changes compared to the previous equivalent time period:

Negative trend (e.g., -63.75): Declined requests decreased by 63.75%
Positive trend (e.g., +45.20): Declined requests increased by 45.20%
Zero trend (0): No change from previous period

Important Notes

Trends are calculated by comparing to the equivalent previous time period
A decrease in bannedReqCount trend may indicate reduced attack activity or rule adjustments
botReqCount specifically tracks automated bot traffic detected by BotBye's bot detection algorithms
bannedReqCount includes requests blocked by your custom security rules
The customerId field is always null for project-level aggregations

\n","type":"text/plain"},"key":"interval","value":"1"},{"disabled":true,"description":{"content":"

(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.

\n","type":"text/plain"},"key":"interval_type","value":"DAY"}],"variable":[]}},"response":[{"id":"ce1f0fd0-9d87-48b7-b96c-9ec8174a1621","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests/count?interval=7&interval_type=DAY","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests","count"],"query":[{"key":"interval","value":"7","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"208"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_2024-08-17_0\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"bannedReqCount\": 56298,\n \"bannedReqTrend\": -63.75,\n \"botReqCount\": 0,\n \"botReqTrend\": 0\n}"},{"id":"ad6c9ae3-8cbc-4f96-825e-cb9d1842049e","name":"fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}2/overviews/declined_requests/count?interval=7&interval_type=DAY","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}2","overviews","declined_requests","count"],"query":[{"key":"interval","value":"7","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Invalid path param 'project_id'. Should be type of 'UUID'.\",\n \"code\": \"protectionapifacade.invalidPathParam\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"param\": \"project_id\",\n \"type\": \"UUID\"\n }\n }\n]"}],"_postman_id":"a4765a0d-b4b2-4a38-aa5e-dda5426372b6"},{"name":"declined requests summary","id":"d5631686-ada8-4551-9c22-b6ea43eeb772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=total_endpoint","description":"

Get Declined Requests Summary

Retrieves a summarized breakdown of declined requests based on different analysis dimensions. This endpoint allows you to analyze blocked traffic by attack source, country, endpoint, reason, or rule, providing actionable insights for security optimization.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier for which to retrieve declined request summaries

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`type`	string	Yes	Summary type: `attack_source`, `country`, `endpoint`, `reason`, or `rule`

Additional time-based filtering parameters are supported. See Pagination query parameters.

Response Structure

Common Properties (All Summary Types)

All summary types return an array of objects with these common fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier (format varies by summary type)
`projectId`	string	The project identifier
`customerId`	null	Always null for project-level data
`declinedReqCount`	integer	Number of declined requests for this summary item

Summary Type: `attack_source`

Analyzes declined requests by IP address and country of origin.

Additional Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`remoteAddr`	string	IP address from which declined requests originated
`country`	string	Country code (ISO 3166-1 alpha-3) of the IP address

Example Response:

[\n  {\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_104.28.247.47_DEU\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"remoteAddr\": \"104.28.247.47\",\n    \"country\": \"DEU\",\n    \"declinedReqCount\": 356\n  }\n]\n

Summary Type: `country`

Analyzes declined requests grouped by country.

Additional Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`country`	string	Country code (ISO 3166-1 alpha-3) where requests originated

Example Response:

[\n  {\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_USA\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"country\": \"USA\",\n    \"declinedReqCount\": 1523\n  }\n]\n

Summary Type: `endpoint`

Analyzes declined requests grouped by API endpoint/URI.

Additional Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`requestUri`	string	The API endpoint URI that received declined requests

Example Response:

[\n  {\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_/api/v1/login\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"requestUri\": \"/api/v1/login\",\n    \"declinedReqCount\": 892\n  }\n]\n

Summary Type: `reason`

Analyzes declined requests grouped by the reason for blocking.

Additional Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`failedMessage`	string	The reason/message explaining why the request was declined

Example Response:

[\n  {\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_Rate limit exceeded\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"failedMessage\": \"Rate limit exceeded\",\n    \"declinedReqCount\": 2341\n  }\n]\n

Summary Type: `rule`

Analyzes declined requests grouped by the security rule that blocked them.

Additional Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`ruleId`	string	The identifier of the security rule that declined the requests
`ruleName`	string	The name of the security rule

Example Response:

[\n  {\n    \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_rule-123\",\n    \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n    \"customerId\": null,\n    \"ruleId\": \"rule-123\",\n    \"ruleName\": \"Block suspicious user agents\",\n    \"declinedReqCount\": 678\n  }\n]\n

Use Cases

Threat Intelligence: Identify top attack sources by IP and country
Geographic Analysis: Understand which countries generate the most malicious traffic
Endpoint Protection: Identify which endpoints are most frequently targeted
Rule Optimization: Analyze which security rules are most effective
Attack Pattern Analysis: Understand common reasons for request blocking
Whitelist Management: Identify legitimate traffic that may need whitelisting
Security Reporting: Generate detailed reports on attack patterns

Important Notes

The type query parameter is required and determines the response structure
Results are typically ordered by declinedReqCount in descending order (most declined first)
Use this endpoint to drill down into specific aspects of your declined traffic
Combine with time filters to analyze trends over specific periods
Country codes follow ISO 3166-1 alpha-3 standard (e.g., USA, DEU, GBR)

(Required) attack_source, country, endpoint, total_endpoint, reason, rule

\n","type":"text/plain"},"key":"type","value":"total_endpoint"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"interval","value":"1"},{"disabled":true,"description":{"content":"

(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.

\n","type":"text/plain"},"key":"interval_type","value":"DAY"}],"variable":[]}},"response":[{"id":"d62cd688-2a5e-4009-833c-c3a1d2ece536","name":"success - attack source summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=attack_source&interval=1","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"attack_source","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1812"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_82.209.216.44_DEU\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"82.209.216.44\",\n \"country\": \"DEU\",\n \"declinedReqCount\": 183\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_104.28.247.47_DEU\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"104.28.247.47\",\n \"country\": \"DEU\",\n \"declinedReqCount\": 179\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_116.202.24.183_DEU\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"116.202.24.183\",\n \"country\": \"DEU\",\n \"declinedReqCount\": 153\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_116.202.24.183_USA\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"116.202.24.183\",\n \"country\": \"USA\",\n \"declinedReqCount\": 118\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_82.209.216.44_BLR\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"82.209.216.44\",\n \"country\": \"BLR\",\n \"declinedReqCount\": 113\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_104.28.247.47_USA\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"104.28.247.47\",\n \"country\": \"USA\",\n \"declinedReqCount\": 86\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_104.28.247.47_BLR\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"104.28.247.47\",\n \"country\": \"BLR\",\n \"declinedReqCount\": 85\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_116.202.24.183_BLR\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"116.202.24.183\",\n \"country\": \"BLR\",\n \"declinedReqCount\": 84\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_82.209.216.44_USA\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"remoteAddr\": \"82.209.216.44\",\n \"country\": \"USA\",\n \"declinedReqCount\": 30\n }\n]"},{"id":"9cfc8096-760b-461c-bd73-c6abc5fdaec2","name":"success - country summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=country&interval=1","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"country","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"475"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_USA\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"country\": \"USA\",\n \"declinedReqCount\": 356\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_DEU\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"country\": \"DEU\",\n \"declinedReqCount\": 350\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_BLR\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"country\": \"BLR\",\n \"declinedReqCount\": 325\n }\n]"},{"id":"456c4f7d-5ebc-4666-bad5-7bf30493d17f","name":"success - total_declined_endpoint summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=endpoint&interval=1","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"endpoint","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"781"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/protect\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/protect\",\n \"declinedReqCount\": 286\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/login\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"declinedReqCount\": 278\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/register\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"declinedReqCount\": 246\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/book\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/book\",\n \"declinedReqCount\": 221\n }\n]"},{"id":"895d4f17-09fe-4c27-b660-0a2986b9041b","name":"success - reason summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=reason&interval=1","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"reason","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"327"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_isBot\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"failedMessage\": \"isBot\",\n \"declinedReqCount\": 528\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"failedMessage\": \"\",\n \"declinedReqCount\": 503\n }\n]"},{"id":"9a1308ca-4610-4b60-97b5-322b1a382034","name":"success - rule summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=rule&interval=30","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"rule","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"30","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"670"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_0191a397-19b3-7c43-a7a1-b7caef503a7e\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"ruleId\": \"0191a397-19b3-7c43-a7a1-b7caef503a7e\",\n \"declinedReqCount\": 435\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_0191a397-2e67-72ca-b823-5663cacc0f16\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"ruleId\": \"0191a397-2e67-72ca-b823-5663cacc0f16\",\n \"declinedReqCount\": 415\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_0191a396-2a36-7c01-aaa7-363ef003f930\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"ruleId\": \"0191a396-2a36-7c01-aaa7-363ef003f930\",\n \"declinedReqCount\": 402\n }\n]"},{"id":"f202216a-4973-4f71-8f7e-2cbb02d7c034","name":"fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}2/overviews/declined_requests?type=attack_source&interval=1","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}2","overviews","declined_requests"],"query":[{"key":"type","value":"attack_source","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 0, meaning the current day or default period is considered."},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Invalid path param 'project_id'. Should be type of 'UUID'.\",\n \"code\": \"protectionapifacade.invalidPathParam\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"param\": \"project_id\",\n \"type\": \"UUID\"\n }\n }\n]"},{"id":"4559e0a5-6007-4132-b9f3-6a6a1ed057d8","name":"success - total_endpoint summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/overviews/declined_requests?type=total_endpoint","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","overviews","declined_requests"],"query":[{"key":"type","value":"total_endpoint","description":"(Required) attack_source, country, endpoint, total_endpoint, reason, rule"},{"key":"interval","value":"1","description":"(Optional) Defines the interval for the overview. The interval is used in conjunction with intervalType to determine the specific time span of the overview. The default value is 1, meaning the current day (or month if interval_type = month).","disabled":true},{"key":"interval_type","value":"DAY","type":"text","description":"(Optional) Specifies the type of interval for the overview. This can be HOUR, DAY, MONTH. The default value is DAY, meaning the overview will cover a single day.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"807"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/protect\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/protect\",\n \"total\": 16,\n \"trend\": -42.86\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/login\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"total\": 16,\n \"trend\": -50.510000000000005\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/register\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"total\": 15,\n \"trend\": -108.33\n },\n {\n \"id\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d_GET_/book\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"customerId\": null,\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/book\",\n \"total\": 15,\n \"trend\": 458.82\n }\n]"}],"_postman_id":"d5631686-ada8-4551-9c22-b6ea43eeb772"}],"id":"d0cc5ffd-91b1-40c1-94cf-4334bb214118","description":"

Overview Endpoints

This folder contains endpoints for retrieving high-level analytics and overview data for your BotBye projects. These endpoints provide aggregated metrics about request traffic, declined requests, and security events over specified time periods.

Purpose

The Overview endpoints enable you to:

Monitor overall request traffic patterns (allowed vs. declined)
Track declined request trends and identify potential threats
Analyze declined requests by various dimensions (attack source, country, endpoint, reason, rule)
Generate reports for security analysis and compliance

Endpoints in this Folder

Requests Overview - Get aggregated request statistics over time
Declined Requests Count - Retrieve counts and trends of declined requests
Declined Requests Summary - Analyze declined requests by different summary types

Common Use Cases

Security Monitoring: Track and analyze attack patterns and declined requests
Traffic Analysis: Understand request volume trends over time
Threat Intelligence: Identify attack sources by IP, country, or endpoint
Compliance Reporting: Generate security reports for audits
Performance Optimization: Identify endpoints receiving high volumes of malicious traffic

Authentication

All endpoints in this folder require API key authentication. Include your API key in the request headers:

Authorization: Bearer {api_key}\n

Required Variables

base_url - The base URL for the BotBye API
account_id - Your unique account identifier
project_id - The project identifier for which you want to retrieve overview data
api_key - Your API authentication key

Time Periods

Most overview endpoints support time-based filtering through query parameters to retrieve data for specific date ranges (hourly, daily, or monthly aggregations).

\n","_postman_id":"d0cc5ffd-91b1-40c1-94cf-4334bb214118","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Requests","item":[{"name":"requests","id":"329a1ae6-eb1a-498a-9b7b-ecb6e6403340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests","description":"

Get Requests

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

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests\n\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier for which to retrieve request logs

Query Parameters

This endpoint supports pagination and filtering parameters:

Pagination: See Pagination query parameters for details on first, after, last, before parameters
\n
Filtering: Additional filters may be available for date ranges, request status, IP addresses, etc.
\n

Response Structure

The response follows a cursor-based pagination pattern:

{\n  \"edges\": [\n    {\n      \"cursor\": \"string\",\n      \"node\": {\n        \"id\": \"string\",\n        \"token\": \"string\",\n        \"customerId\": \"string\",\n        \"projectId\": \"string\",\n        \"siteKey\": \"string\",\n        \"serverKey\": \"string\",\n        \"referer\": \"string\",\n        \"userAgent\": \"string\",\n        \"host\": \"string\",\n        \"requestMethod\": \"string\",\n        \"requestUri\": \"string\",\n        \"remoteAddr\": \"string\",\n        \"serverName\": \"string\",\n        \"remoteUser\": \"string\",\n        \"serverPort\": integer,\n        \"requestInfo\": \"string\",\n        \"failedMessage\": \"string\",\n        \"failedChecks\": \"string\",\n        \"customFields\": [],\n        \"headers\": \"string\",\n        \"createdAt\": \"string\",\n        \"realIp\": \"string\",\n        \"country\": \"string\",\n        \"asn\": \"string\",\n        \"isProtected\": boolean,\n        \"isBanByRule\": boolean\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"hasPreviousPage\": boolean,\n    \"hasNextPage\": boolean,\n    \"startCursor\": \"string | null\",\n    \"endCursor\": \"string | null\",\n    \"total\": integer\n  }\n}\n\n

Response Fields

edges (array): Contains the request records

cursor (string): Pagination cursor for this record
\n
node (object): The request data with the following fields:
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier for this request
`token`	string	BotBye token associated with the request
`customerId`	string	Customer identifier (if applicable)
`projectId`	string	The project identifier
`siteKey`	string	The site key used for this request
`serverKey`	string	The server key used for validation
`referer`	string	HTTP Referer header value
`userAgent`	string	User-Agent header value
`host`	string	Host header value
`requestMethod`	string	HTTP method (GET, POST, PUT, DELETE, etc.)
`requestUri`	string	The request URI/endpoint
`remoteAddr`	string	IP address of the client
`serverName`	string	Server name that processed the request
`remoteUser`	string	Remote user identifier (if authenticated)
`serverPort`	integer	Server port number
`requestInfo`	string	Additional request information
`failedMessage`	string	Reason for declining the request (if declined)
`failedChecks`	string	Specific security checks that failed
`customFields`	array	Custom fields passed with the request
`headers`	string	Complete request headers (JSON string)
`createdAt`	string	ISO 8601 timestamp when the request was processed
`realIp`	string	Real IP address (if behind proxy/CDN)
`country`	string	Country code (ISO 3166-1 alpha-3) of the IP
`asn`	string	Autonomous System Number of the IP
`isProtected`	boolean	Whether the request was protected by BotBye
`isBanByRule`	boolean	Whether the request was banned by a custom rule

pageInfo (object): Pagination metadata

hasPreviousPage (boolean): Whether there are more results before the current page
\n
hasNextPage (boolean): Whether there are more results after the current page
\n
startCursor (string | null): Cursor pointing to the first item
\n
endCursor (string | null): Cursor pointing to the last item
\n
total (integer): Total number of requests found
\n

Example Response

{\n  \"edges\": [\n    {\n      \"cursor\": \"YXJyYXljb25uZWN0aW9uOjA=\",\n      \"node\": {\n        \"id\": \"req_abc123xyz\",\n        \"token\": \"tok_def456\",\n        \"customerId\": \"cust_789\",\n        \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n        \"siteKey\": \"sk_live_abc123\",\n        \"serverKey\": \"srv_key_xyz\",\n        \"referer\": \"https://example.com/login\",\n        \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64)...\",\n        \"host\": \"api.example.com\",\n        \"requestMethod\": \"POST\",\n        \"requestUri\": \"/api/v1/auth/login\",\n        \"remoteAddr\": \"203.0.113.42\",\n        \"serverName\": \"api-server-01\",\n        \"remoteUser\": null,\n        \"serverPort\": 443,\n        \"requestInfo\": \"Login attempt\",\n        \"failedMessage\": \"Rate limit exceeded\",\n        \"failedChecks\": \"rate_limit\",\n        \"customFields\": [],\n        \"headers\": \"{\\\"Content-Type\\\":\\\"application/json\\\",\\\"Authorization\\\":\\\"Bearer ...\\\"}\",\n        \"createdAt\": \"2024-08-24T15:32:10Z\",\n        \"realIp\": \"203.0.113.42\",\n        \"country\": \"USA\",\n        \"asn\": \"AS15169\",\n        \"isProtected\": true,\n        \"isBanByRule\": true\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"hasPreviousPage\": false,\n    \"hasNextPage\": true,\n    \"startCursor\": \"YXJyYXljb25uZWN0aW9uOjA=\",\n    \"endCursor\": \"YXJyYXljb25uZWN0aW9uOjA=\",\n    \"total\": 15847\n  }\n}\n\n

Use Cases

Security Investigation: Analyze specific requests to understand security decisions
\n
Debugging: Troubleshoot why legitimate requests are being blocked
\n
Audit Logging: Maintain comprehensive logs for compliance and security audits
\n
Threat Analysis: Study attack patterns by examining declined request details
\n
False Positive Analysis: Review blocked requests to tune security rules
\n
Performance Monitoring: Track request patterns and identify bottlenecks
\n
Customer Support: Investigate user-reported issues with specific requests
\n
Forensic Analysis: Deep-dive into security incidents with complete request data
\n

Pagination Example

To retrieve the next page of results:

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests?after=YXJyYXljb25uZWN0aW9uOjA=&first=50\n\n

Important Notes

Data Volume: This endpoint can return large amounts of data; use pagination effectively
\n
Headers: The headers field contains a JSON string that needs to be parsed
\n
IP Addresses: remoteAddr shows the direct connection IP, while realIp shows the actual client IP (useful when behind proxies/CDNs)
\n
Failed Requests: Check failedMessage and failedChecks to understand why requests were declined
\n
Custom Fields: Use customFields to pass and retrieve application-specific data
\n
Data Retention: Request logs are retained according to your BotBye plan
\n
Performance: For high-traffic projects, consider filtering by date range to improve query performance
\n
Privacy: Request data may contain sensitive information; handle according to your privacy policies
\n

Filtering Best Practices

Filter by date range for better performance on high-traffic projects
\n
Use isBanByRule: true to focus on rule-based blocks
\n
Filter by country or asn to analyze geographic patterns
\n
Combine filters to narrow down specific security events
\n

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"where","value":""},{"disabled":true,"description":{"content":"

(Optional): property by which to order by.\n - fieldPath (string): name of order field.\n - direction (string): ASC or DESC

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100.

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"6d1af311-9b07-41c4-810c-f0d868234f37","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","requests"],"query":[{"key":"cursor","value":null,"type":"text","disabled":true},{"key":"where","value":null,"type":"text","disabled":true},{"key":"order_by","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"24120"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4691-722c-a79f-d9fd46bf065a\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586513\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId8\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTcyLWQ0MjRhMDU4ZGU2NA==\",\n \"node\": {\n \"id\": \"0190d9f1-4692-7c64-ba72-d424a058de64\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/book\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586514\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId3\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTVaLDAxOTBkOWYxLTQ2OTMtN2Y3MS1iMDdiLTVmYzFmMmMzODlhZg==\",\n \"node\": {\n \"id\": \"0190d9f1-4693-7f71-b07b-5fc1f2c389af\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 Edg/91.0.864.59\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586515\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId0\",\n \"sessionId\": \"sessionId0\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTVaLDAxOTBkOWYxLTQ2OTMtN2Y3MS1iMGI3LWU0MTg3OWE1YjZmOQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4693-7f71-b0b7-e41879a5b6f9\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586515\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId4\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTU3LWQ2MmYzY2NmZDhiNw==\",\n \"node\": {\n \"id\": \"0190d9f1-4694-7aa6-8157-d62f3ccfd8b7\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586516\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId3\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTkzLWM1MTI3NmU1M2Y5Ng==\",\n \"node\": {\n \"id\": \"0190d9f1-4694-7aa6-8193-c51276e53f96\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/protect\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586516\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId4\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNWZlLTU2NzBlNTc1YTU5Ng==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b5fe-5670e575a596\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId7\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNjNhLTcwNzM2OWY2MjdiZQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b63a-707369f627be\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId2\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNjc2LTcyMmY5NzE0YjdiYg==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b676-722f9714b7bb\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586517\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId0\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNmIyLTRjN2I3NGUwYWQyOQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b6b2-4c7b74e0ad29\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId7\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNmVlLTdlOTMzNDI0ODQ4Yw==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b6ee-7e933424848c\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId5\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MThaLDAxOTBkOWYxLTQ2OTYtNzc3Ni1hMWU2LWIyY2U4NzQ1MGU3Mg==\",\n \"node\": {\n \"id\": \"0190d9f1-4696-7776-a1e6-b2ce87450e72\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586518\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId1\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MThaLDAxOTBkOWYxLTQ2OTYtNzc3Ni1hMjIyLTI5NmQzNzdjMjg1YQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4696-7776-a222-296d377c285a\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586518\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId0\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTM3LTllYjIxYzE1MjY1Nw==\",\n \"node\": {\n \"id\": \"0190d9f1-4692-7c64-ba37-9eb21c152657\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646514\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId2\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTVaLDAxOTBkOWYxLTQ2OTMtN2Y3MS1iMDQwLWYyNmQwNjQ4MjYzYw==\",\n \"node\": {\n \"id\": \"0190d9f1-4693-7f71-b040-f26d0648263c\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/book\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646515\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId5\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTVaLDAxOTBkOWYxLTQ2OTMtN2Y3MS1iMDdjLTk5MjhkMGIyM2M3MA==\",\n \"node\": {\n \"id\": \"0190d9f1-4693-7f71-b07c-9928d0b23c70\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646515\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId1\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTVaLDAxOTBkOWYxLTQ2OTMtN2Y3MS1iMGI4LWRlNWFhZmZhMTViNw==\",\n \"node\": {\n \"id\": \"0190d9f1-4693-7f71-b0b8-de5aaffa15b7\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646515\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId2\",\n \"sessionId\": \"sessionId0\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTU4LTZmNzNkNTNlYzk0Yw==\",\n \"node\": {\n \"id\": \"0190d9f1-4694-7aa6-8158-6f73d53ec94c\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"116.202.24.183\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646516\",\n \"realIp\": \"\",\n \"country\": \"USA\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId0\",\n \"sessionId\": \"sessionId1\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTk0LTE1Njg1NGE1ZThiYg==\",\n \"node\": {\n \"id\": \"0190d9f1-4694-7aa6-8194-156854a5e8bb\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/protect\",\n \"remoteAddr\": \"82.209.216.44\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646516\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId6\",\n \"sessionId\": \"sessionId0\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNWZmLTNmYTBlMjc3NzI0MA==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b5ff-3fa0e2777240\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId8\",\n \"sessionId\": \"sessionId0\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": true,\n \"startCursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"endCursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNWZmLTNmYTBlMjc3NzI0MA==\",\n \"total\": 14914120\n },\n \"attributes\": {}\n}"},{"id":"c16e20aa-28f4-4e4d-b4a9-cb09acb8c3a6","name":"fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}2/requests","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}2","requests"],"query":[{"key":"cursor","value":null,"type":"text","disabled":true},{"key":"where","value":null,"type":"text","disabled":true},{"key":"order_by","value":null,"type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Invalid path param 'project_id'. Should be type of 'UUID'.\",\n \"code\": \"protectionapifacade.invalidPathParam\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"param\": \"project_id\",\n \"type\": \"UUID\"\n }\n }\n]"},{"id":"a182d40f-d8d8-4445-b08c-3dd2d3d9af90","name":"cursor + limit","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests?cursor=%7B%22after%22%3A%20%22MjAyNC0wNi0wM1QxMzoxNzoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTk0LTE1Njg1NGE1ZThiYg%3D%3D%22%7D&limit=2","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","requests"],"query":[{"key":"cursor","value":"%7B%22after%22%3A%20%22MjAyNC0wNi0wM1QxMzoxNzoyNi41MTZaLDAxOTBkOWYxLTQ2OTQtN2FhNi04MTk0LTE1Njg1NGE1ZThiYg%3D%3D%22%7D","type":"text","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved."},{"key":"where","value":"","type":"text","description":"(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).\n\t- `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]]\n\t- `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`).\n\t- `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).\n\t- `value` (string): The value to compare against the field (used only for a leaf).","disabled":true},{"key":"order_by","value":"","type":"text","description":"(Optional): property by which to order by.\n\t- `fieldPath` (string): name of order field.\n\t- `direction` (string): `ASC` or `DESC`","disabled":true},{"key":"limit","value":"2","description":"(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2701"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNWZmLTNmYTBlMjc3NzI0MA==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b5ff-3fa0e2777240\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"d415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"ead5d8e1-1b0b-4465-899e-3e882c51133b\",\n \"siteKey\": \"ec095e98-07ca-4009-9b3a-b4703e5107d6\",\n \"serverKey\": \"666f49f6-7678-494b-833d-85690d653ee8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId8\",\n \"sessionId\": \"sessionId0\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNjNiLTVhODExY2NkYTFiYQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4695-776b-b63b-5a811ccda1ba\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"5c53992b-30b7-4ac0-99e6-b36492857f03\",\n \"siteKey\": \"43de1194-80dc-466f-b027-01b552d0a7ed\",\n \"serverKey\": \"446a046c-3b60-4694-b6ca-07c0e1dc76d5\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646517\",\n \"realIp\": \"\",\n \"country\": \"BLR\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": false,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"ALLOWED\",\n \"visitorId\": \"visitorId6\",\n \"sessionId\": \"sessionId0\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": true,\n \"hasNextPage\": true,\n \"startCursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNWZmLTNmYTBlMjc3NzI0MA==\",\n \"endCursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTdaLDAxOTBkOWYxLTQ2OTUtNzc2Yi1iNjNiLTVhODExY2NkYTFiYQ==\",\n \"total\": 15646980\n },\n \"attributes\": {}\n}"},{"id":"824d9092-ecc5-4068-b88a-7b0998c390e1","name":"where country = DEU and ip eq 104.28.247.47","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests?where=%7B%22operands%22%3A%5B%7B%22fieldPath%22%3A%22country%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22DEU%22%7D%2C%7B%22fieldPath%22%3A%22remote_addr%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22104.28.247.47%22%7D%5D%2C%22predicate%22%3A%22and%22%7D&limit=2","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","requests"],"query":[{"key":"cursor","value":"","type":"text","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.","disabled":true},{"key":"where","value":"%7B%22operands%22%3A%5B%7B%22fieldPath%22%3A%22country%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22DEU%22%7D%2C%7B%22fieldPath%22%3A%22remote_addr%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22104.28.247.47%22%7D%5D%2C%22predicate%22%3A%22and%22%7D","description":"(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).\n\t- `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]]\n\t- `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`).\n\t- `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).\n\t- `value` (string): The value to compare against the field (used only for a leaf)."},{"key":"order_by","value":"","type":"text","description":"(Optional): property by which to order by.\n\t- `fieldPath` (string): name of order field.\n\t- `direction` (string): `ASC` or `DESC`","disabled":true},{"key":"limit","value":"2","description":"(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"24309"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4691-722c-a79f-d9fd46bf065a\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586513\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId8\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTM3LTllYjIxYzE1MjY1Nw==\",\n \"node\": {\n \"id\": \"0190d9f1-4692-7c64-ba37-9eb21c152657\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646514\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId2\",\n \"sessionId\": \"sessionId2\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": true,\n \"startCursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"endCursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTM3LTllYjIxYzE1MjY1Nw==\",\n \"total\": 1156225\n },\n \"attributes\": {}\n}"},{"id":"3da0e97c-2cc7-47a6-aa85-1c4be4c22da5","name":"where country = DEU and ip in list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/requests?where=%7B%22operands%22%3A%5B%7B%22fieldPath%22%3A%22country%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22DEU%22%7D%2C%7B%22fieldPath%22%3A%22remote_addr%22%2C%22predicate%22%3A%22in%22%2C%22value%22%3A%22%5B'104.28.247.47'%2C'116.202.24.183'%5D%22%7D%5D%2C%22predicate%22%3A%22and%22%7D&limit=2","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","requests"],"query":[{"key":"cursor","value":"","type":"text","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.","disabled":true},{"key":"where","value":"%7B%22operands%22%3A%5B%7B%22fieldPath%22%3A%22country%22%2C%22predicate%22%3A%22eq%22%2C%22value%22%3A%22DEU%22%7D%2C%7B%22fieldPath%22%3A%22remote_addr%22%2C%22predicate%22%3A%22in%22%2C%22value%22%3A%22%5B'104.28.247.47'%2C'116.202.24.183'%5D%22%7D%5D%2C%22predicate%22%3A%22and%22%7D","type":"text","description":"(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).\n\t- `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]]\n\t- `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`).\n\t- `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).\n\t- `value` (string): The value to compare against the field (used only for a leaf)."},{"key":"order_by","value":"","type":"text","description":"(Optional): property by which to order by.\n\t- `fieldPath` (string): name of order field.\n\t- `direction` (string): `ASC` or `DESC`","disabled":true},{"key":"limit","value":"2","description":"(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2673"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"node\": {\n \"id\": \"0190d9f1-4691-722c-a79f-d9fd46bf065a\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 OPR/76.0.4017.123\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/register\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420586513\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId8\",\n \"sessionId\": \"sessionId2\"\n }\n },\n {\n \"cursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTM3LTllYjIxYzE1MjY1Nw==\",\n \"node\": {\n \"id\": \"0190d9f1-4692-7c64-ba37-9eb21c152657\",\n \"token\": \"P19QiBW+Qn5lczgfdXAmy7kSwASb09TSBsLKiAzeH651CtPqk+7Y31ftntNATByyhg0=\",\n \"customerId\": \"c415a474-be24-11eb-8529-0242ac130003\",\n \"projectId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"serverKey\": \"ee6c6c65-b696-43a1-8ed1-624f67dc3fc8\",\n \"referer\": \"\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0\",\n \"host\": \"127.0.0.1\",\n \"requestMethod\": \"GET\",\n \"requestUri\": \"/login\",\n \"remoteAddr\": \"104.28.247.47\",\n \"serverName\": \"localhost\",\n \"remoteUser\": \"\",\n \"serverPort\": 80,\n \"requestInfo\": \"{\\\"request_uri\\\":\\\"\\\",\\\"request_method\\\":\\\"GET\\\",\\\"server_name\\\":\\\"\\\",\\\"remote_addr\\\":\\\"\\\",\\\"server_port\\\":0}\",\n \"failedMessage\": \"isBot\",\n \"failedChecks\": \"\",\n \"customFields\": [\n \"1\",\n \"\",\n \"\"\n ],\n \"headers\": \"{}\",\n \"createdAt\": \"1717420646514\",\n \"realIp\": \"\",\n \"country\": \"DEU\",\n \"asn\": \"\",\n \"isProtected\": false,\n \"isBanByRule\": true,\n \"realCountry\": \"\",\n \"isBot\": false,\n \"ruleId\": \"00000000-0000-0000-0000-000000000000\",\n \"requestStatus\": \"DECLINED\",\n \"visitorId\": \"visitorId2\",\n \"sessionId\": \"sessionId2\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": true,\n \"startCursor\": \"MjAyNC0wNi0wM1QxMzoxNjoyNi41MTNaLDAxOTBkOWYxLTQ2OTEtNzIyYy1hNzlmLWQ5ZmQ0NmJmMDY1YQ==\",\n \"endCursor\": \"MjAyNC0wNi0wM1QxMzoxNzoyNi41MTRaLDAxOTBkOWYxLTQ2OTItN2M2NC1iYTM3LTllYjIxYzE1MjY1Nw==\",\n \"total\": 2313243\n },\n \"attributes\": {}\n}"}],"_postman_id":"329a1ae6-eb1a-498a-9b7b-ecb6e6403340"}],"id":"10714e5d-8572-4a0a-a3b2-9f7b8f9e1eac","description":"

Requests Endpoints

This folder contains endpoints for retrieving detailed information about individual requests processed by BotBye. These endpoints provide granular, request-level data including headers, IP addresses, security checks, and decision outcomes.

Purpose

The Requests endpoints enable you to:

Retrieve detailed logs of all requests processed by BotBye
Investigate specific requests for security analysis
Access comprehensive request metadata (headers, IP, user agent, etc.)
Understand why requests were allowed or declined
Perform forensic analysis on security events

Endpoints in this Folder

Requests - Retrieve a paginated list of all requests for a project

Common Use Cases

Security Investigation: Deep-dive into specific requests to understand security decisions
Debugging: Troubleshoot why legitimate requests might be getting blocked
Audit Logging: Maintain detailed logs of all API traffic for compliance
Threat Analysis: Analyze request patterns to identify attack vectors
False Positive Analysis: Review declined requests to tune security rules
Customer Support: Investigate user-reported issues with request blocking

Authentication

All endpoints in this folder require API key authentication. Include your API key in the request headers:

Authorization: Bearer {api_key}\n

Required Variables

base_url - The base URL for the BotBye API
account_id - Your unique account identifier
project_id - The project identifier for which you want to retrieve requests
api_key - Your API authentication key

Pagination

Request endpoints support pagination to handle large volumes of data efficiently. Use the standard pagination query parameters to navigate through results.

Data Retention

Request data is retained according to your BotBye plan. Ensure you export or archive important request logs as needed for long-term storage.

\n","_postman_id":"10714e5d-8572-4a0a-a3b2-9f7b8f9e1eac","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Multi accounts","item":[{"name":"find","id":"c99ea95e-0d81-4d8c-8921-1a5e62928270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts/{id}","description":"

Get Multi-Account Details

Retrieves detailed information about a specific user's multi-account associations. This endpoint returns the account IDs that have been linked to a particular user, helping you investigate individual cases of multi-account usage.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts/{id}\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier where the multi-account was detected
`id`	string	Yes	The specific user account identifier to investigate

Response Structure

The response returns an array of account identifiers associated with the specified user:

[\"string\", \"string\", \"string\"]\n

Each string in the array represents a unique account ID that has been linked to the same user/device/browser fingerprint.

Example Response

[\"1\", \"5\", \"10\"]\n

This response indicates that accounts with IDs \"1\", \"5\", and \"10\" are all associated with the same user.

Example Response (Detailed)

[\n  \"acc_abc123\",\n  \"acc_def456\", \n  \"acc_ghi789\"\n]\n

This indicates three separate accounts have been detected as belonging to the same user based on device fingerprinting.

Use Cases

Fraud Investigation: Deep-dive into specific users suspected of multi-account fraud
Account Linking: Understand which accounts are operated by the same individual
Ban Enforcement: Identify all accounts that should be banned when one account violates policies
Customer Support: Investigate user reports of account issues or false positives
Forensic Analysis: Trace account relationships during security investigations
Abuse Pattern Analysis: Study how specific users create and use multiple accounts

Interpreting Results

Empty array []: No multi-account associations found for this user ID
Single item [\"1\"]: Only one account detected (no multi-account behavior)
Multiple items [\"1\", \"5\", \"10\"]: Multiple accounts detected from the same user

The number of accounts in the response indicates the severity of multi-account usage:

2-3 accounts: May be legitimate (e.g., test accounts, family members)
4-10 accounts: Likely policy violation or moderate abuse
10+ accounts: Strong indicator of fraud or systematic abuse

Important Notes

The id parameter should be a user identifier from your system that was passed to BotBye
Account IDs in the response correspond to identifiers from your application
This endpoint is useful for investigating specific users flagged by the \"Find by Project\" endpoint
Consider the context when evaluating multi-account associations (shared devices, legitimate use cases)
Use this data in combination with other signals (behavior patterns, timing, IP addresses) for accurate fraud detection
Implement appropriate privacy controls when storing or displaying multi-account association data

Error Responses

404 Not Found: The specified user ID has no multi-account data or doesn't exist
403 Forbidden: Invalid API key or insufficient permissions
400 Bad Request: Invalid account_id, project_id, or id format

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}},"urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts","{id}"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"6ca5b2b5-636d-4b92-a1bd-e9da5601179f","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"17"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n \"a\",\n \"b\",\n \"c\",\n \"e\"\n]"}],"_postman_id":"c99ea95e-0d81-4d8c-8921-1a5e62928270"},{"name":"findByProject","id":"53d215ff-aa75-41fa-a7db-0d6436677da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts","description":"

Get Multi-Accounts by Project

Retrieves all multi-account associations detected within a specific project. This endpoint returns a paginated list of users who have been identified as operating multiple accounts, helping you detect and prevent fraud, abuse, and policy violations.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts\n

Authentication

Requires API key authentication:

Authorization: Bearer {api_key}\n

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`account_id`	string	Yes	Your unique BotBye account identifier
`project_id`	string	Yes	The project identifier for which to retrieve multi-account data

Query Parameters

This endpoint supports pagination parameters to navigate through large result sets:

See Pagination query parameters for details on first, after, last, before parameters

Response Structure

The response follows a cursor-based pagination pattern with the following structure:

{\n  \"edges\": [\n    {\n      \"cursor\": \"string\",\n      \"node\": {\n        \"userId\": \"string\",\n        \"accountId\": \"string\",\n        \"siteKey\": \"string\",\n        \"createdAt\": \"string (ISO 8601 datetime)\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"hasPreviousPage\": boolean,\n    \"hasNextPage\": boolean,\n    \"startCursor\": \"string | null\",\n    \"endCursor\": \"string | null\",\n    \"total\": integer\n  },\n  \"attributes\": {}\n}\n

Response Fields

edges (array): Contains the multi-account records

cursor (string): Pagination cursor for this record
node (object): The multi-account data
- userId (string): The user identifier associated with multiple accounts
- accountId (string): The BotBye account identifier
- siteKey (string): The site/project key where the multi-account was detected
- createdAt (string): ISO 8601 timestamp when the multi-account association was first detected
\n

pageInfo (object): Pagination metadata

hasPreviousPage (boolean): Whether there are more results before the current page
hasNextPage (boolean): Whether there are more results after the current page
startCursor (string | null): Cursor pointing to the first item in the current page
endCursor (string | null): Cursor pointing to the last item in the current page
total (integer): Total number of multi-account associations found

attributes (object): Additional metadata (typically empty)

Example Response

{\n  \"edges\": [\n    {\n      \"cursor\": \"YXJyYXljb25uZWN0aW9uOjA=\",\n      \"node\": {\n        \"userId\": \"user_abc123\",\n        \"accountId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n        \"siteKey\": \"sk_live_abc123xyz\",\n        \"createdAt\": \"2024-08-17T14:32:10Z\"\n      }\n    },\n    {\n      \"cursor\": \"YXJyYXljb25uZWN0aW9uOjE=\",\n      \"node\": {\n        \"userId\": \"user_def456\",\n        \"accountId\": \"185071d5-d4fe-4bea-93df-19d0bd8c2d0d\",\n        \"siteKey\": \"sk_live_abc123xyz\",\n        \"createdAt\": \"2024-08-18T09:15:42Z\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"hasPreviousPage\": false,\n    \"hasNextPage\": true,\n    \"startCursor\": \"YXJyYXljb25uZWN0aW9uOjA=\",\n    \"endCursor\": \"YXJyYXljb25uZWN0aW9uOjE=\",\n    \"total\": 47\n  },\n  \"attributes\": {}\n}\n

Use Cases

Fraud Detection: Identify users creating multiple accounts to abuse promotions or referral programs
Ban Evasion Detection: Detect users creating new accounts after being banned
Policy Enforcement: Enforce terms of service that limit users to single accounts
Abuse Prevention: Prevent vote manipulation, review fraud, or other multi-account abuse
Security Auditing: Review all multi-account associations for security analysis
User Behavior Analysis: Understand patterns of legitimate vs. fraudulent multi-account usage

Pagination Example

To retrieve the next page of results, use the endCursor value:

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts?after=YXJyYXljb25uZWN0aW9uOjE=&first=20\n

Important Notes

Multi-account detection uses advanced device and browser fingerprinting
The same userId appearing multiple times indicates multiple accounts from the same device/browser
createdAt timestamp indicates when BotBye first detected the multi-account association
Use pagination to efficiently process large numbers of multi-account detections
Consider implementing automated workflows to handle detected multi-accounts (e.g., flagging for review, automatic blocking)
False positives can occur in shared device scenarios (e.g., public computers, family devices)

\n","urlObject":{"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts"],"host":["https://api.botbye.com"],"query":[{"disabled":true,"description":{"content":"

(Optional): a cursor for pagination.\n - after (string): Pointer to the item after which the items are to be retrieved.\n - before (string): Pointer to the item before which the items are to be retrieved.\n - first (number): specifies the maximum number of results to return in a single response. By default - 20, max - 500.

\n","type":"text/plain"},"key":"cursor","value":"%7B%22after%22%3A%22W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d%22%2C%22first%22%3A%202%7D"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"where","value":"%7B%0A%20%20%22fieldPath%22%3A%20%22userAccount__createdAt%22%2C%0A%20%20%22predicate%22%3A%20%22gt%22%2C%0A%20%20%22value%22%3A%20%221734626758193%22%0A%7D"}],"variable":[]}},"response":[{"id":"62bc605e-1cd8-4840-a4e5-57ec5e17e775","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts"],"query":[{"key":"cursor","value":"","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.\n\t - `first` (number): specifies the maximum number of results to return in a single response. By default - 20, max - 500.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1186"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImEiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"a\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734624872659\"\n }\n },\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"b\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734624872659\"\n }\n },\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImMiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2NzU4MTkzIl1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"c\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734626758193\"\n }\n },\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImUiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2OTk0NTYzIl1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"e\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734626994563\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": false,\n \"hasNextPage\": false,\n \"startCursor\": null,\n \"endCursor\": null,\n \"total\": 4\n },\n \"attributes\": {}\n}"},{"id":"68b21d70-5f05-424a-85de-80465efe813e","name":"fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts?cursor=%7B%22first%22%3A%20501%7D","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts"],"query":[{"key":"cursor","value":"%7B%22first%22%3A%20501%7D","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.\n\t - `first` (number): specifies the maximum number of results to return in a single response. By default - 20, max - 500.","type":"text"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"143"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\": \"Page limit should be > 1 and <= 500.\",\n \"code\": \"protectionproject.invalidCursor\",\n \"type\": \"SHOWABLE\",\n \"context\": {\n \"pageSizeLimit\": 500\n }\n }\n]"},{"id":"ea2d0e56-df6b-4de4-a086-52e23df44f62","name":"cursor+limit","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts?cursor=%7B%22after%22%3A%22W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d%22%2C%22first%22%3A%202%7D","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts"],"query":[{"key":"cursor","value":"%7B%22after%22%3A%22W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d%22%2C%22first%22%3A%202%7D","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.\n\t - `first` (number): specifies the maximum number of results to return in a single response. By default - 20, max - 500.","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"755"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImMiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2NzU4MTkzIl1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"c\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734626758193\"\n }\n },\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImUiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2OTk0NTYzIl1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"e\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734626994563\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": true,\n \"hasNextPage\": false,\n \"startCursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImMiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2NzU4MTkzIl1d\",\n \"endCursor\": null,\n \"total\": 4\n },\n \"attributes\": {}\n}"},{"id":"b9e02de5-332b-40e0-b1a5-0885bb83deb8","name":"where created_at > 1734626758193","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/multiaccounts?cursor=%7B%22after%22%3A%22W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d%22%2C%22first%22%3A%202%7D&where=%7B%0A%20%20%22fieldPath%22%3A%20%22userAccount__createdAt%22%2C%0A%20%20%22predicate%22%3A%20%22gt%22%2C%0A%20%20%22value%22%3A%20%221734626758193%22%0A%7D","host":["https://api.botbye.com"],"path":["api","v1","{account_id}","projects","{project_id}","multiaccounts"],"query":[{"key":"cursor","value":"%7B%22after%22%3A%22W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImIiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI0ODcyNjU5Il1d%22%2C%22first%22%3A%202%7D","description":"(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved.\n\t - `first` (number): specifies the maximum number of results to return in a single response. By default - 20, max - 500.","type":"text"},{"key":"where","value":"%7B%0A%20%20%22fieldPath%22%3A%20%22userAccount__createdAt%22%2C%0A%20%20%22predicate%22%3A%20%22gt%22%2C%0A%20%20%22value%22%3A%20%221734626758193%22%0A%7D","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"491"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"edges\": [\n {\n \"cursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImUiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2OTk0NTYzIl1d\",\n \"node\": {\n \"userId\": \"0193dfb3-08d2-7d5f-b288-3c8278618aac\",\n \"accountId\": \"e\",\n \"siteKey\": \"e610df2f-2ab3-48b3-90a0-4502b10e1e98\",\n \"createdAt\": \"1734626994563\"\n }\n }\n ],\n \"pageInfo\": {\n \"hasPreviousPage\": true,\n \"hasNextPage\": false,\n \"startCursor\": \"W1sidXNlckFjY291bnRfX2FjY291bnRJZCIsImUiXSxbInVzZXJBY2NvdW50X19jcmVhdGVkQXQiLCIxNzM0NjI2OTk0NTYzIl1d\",\n \"endCursor\": null,\n \"total\": 1\n },\n \"attributes\": {}\n}"}],"_postman_id":"53d215ff-aa75-41fa-a7db-0d6436677da4"}],"id":"2ab9a9c8-4603-493f-abbb-0c4d5675b1a4","description":"

Multi Accounts Endpoints

This folder contains endpoints for managing and retrieving information about multi-account detection within your BotBye projects. Multi-account detection helps identify users who create multiple accounts, which is crucial for preventing fraud, abuse, and policy violations.

Purpose

The Multi Accounts endpoints enable you to:

Detect users operating multiple accounts from the same device or browser
Retrieve multi-account associations for specific projects
Investigate individual user account relationships
Implement fraud prevention and abuse detection strategies

Endpoints in this Folder

Find by Project - Retrieve all multi-account associations for a specific project
Find - Get detailed multi-account information for a specific user account

Common Use Cases

Fraud Prevention: Identify users creating multiple accounts to abuse promotions or bypass restrictions
Account Abuse Detection: Detect ban evasion or policy violation attempts
User Behavior Analysis: Understand patterns of multi-account usage
Compliance Enforcement: Enforce terms of service that restrict multiple accounts
Security Investigation: Investigate suspicious account creation patterns

Authentication

All endpoints in this folder require API key authentication. Include your API key in the request headers:

Authorization: Bearer {api_key}\n

Required Variables

base_url - The base URL for the BotBye API
account_id - Your unique account identifier
project_id - The project identifier for multi-account detection
id - The specific user account identifier (for individual lookups)
api_key - Your API authentication key

How Multi-Account Detection Works

BotBye uses advanced fingerprinting techniques to identify when multiple user accounts are associated with the same device, browser, or user session. This helps you maintain platform integrity and prevent abuse.

\n","_postman_id":"2ab9a9c8-4603-493f-abbb-0c4d5675b1a4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}},{"name":"Privacy","item":[{"name":"get customer privacy data","event":[{"listen":"test","script":{"id":"1c46b9c5-eae2-48d2-ac00-51117d9562ba","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json().edges[0].node.id;","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"429a5e8c-1741-4dc4-997f-fc7d2ad08a8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/data","description":"

Get Customer Privacy Data

Retrieves all privacy-related data associated with a customer account. This endpoint is used to fulfill data subject access requests (DSAR) and provide customers with a complete view of their stored personal information.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/privacy/data\n

Required Variables

base_url: The base URL for the BotBye API
account_id: Your unique account identifier

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a comprehensive JSON object containing all privacy-related data for the customer, including:

Personal information
Account details
Activity logs
Associated metadata

Use Cases

GDPR/CCPA Compliance: Respond to data subject access requests
Data Auditing: Review what personal data is stored
Customer Transparency: Provide customers with their data upon request
Compliance Reporting: Generate reports for regulatory purposes

Example Response

The response includes structured data with customer information organized in a node-based format with edges for relationships.

\n","urlObject":{"path":["api","v1","{account_id}","privacy","data"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"a4f5692e-32b6-4289-a17a-e6b020f54f49","name":"get customer privacy data","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/data"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"1410"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"profile\": {\n \"id\": \"a125a474-be24-11eb-8529-0242ac130003\",\n \"name\": \"Jhon\",\n \"avatarId\": null,\n \"createdAt\": \"1768225357058\",\n \"updatedAt\": \"1768225357058\",\n \"deletedAt\": null\n },\n \"auth\": {\n \"login\": null,\n \"canonicalLogin\": null,\n \"email\": \"jhon_test@test.com\",\n \"phone\": null,\n \"hasPassword\": true,\n \"externalProviders\": [\n \"INTERNAL\"\n ],\n \"activeSessions\": 8\n },\n \"settings\": null,\n \"projects\": [\n {\n \"id\": \"1cdc3658-ef1d-47fe-992b-ae09ae7de58e\",\n \"name\": \"Top Project\",\n \"serverKey\": \"6bc38750-7c9b-4c10-981b-c6f324b8039b\",\n \"siteKey\": \"24eb35f6-29cb-4427-b4a9-952c11bdb15b\",\n \"createdAt\": \"1672531200000\"\n },\n {\n \"id\": \"b5b09618-1b9d-4cf2-8d0c-c8e3851158ed\",\n \"name\": \"Top project 2\",\n \"serverKey\": \"5656495d-e1c6-49a8-b633-bb1f9754dab9\",\n \"siteKey\": \"7b9fab2a-798c-4aaf-9a64-6207aa961b93\",\n \"createdAt\": \"1672617600000\"\n }\n ],\n \"accessTokens\": [\n {\n \"id\": \"d44016e4-7e2d-4390-9ff9-b67383140fe7\",\n \"name\": \"DEV_ACCESS_TOKEN\",\n \"createdAt\": \"1672704000000\",\n \"expiresAt\": \"4828377600000\"\n }\n ],\n \"invitations\": [\n {\n \"email\": \"alice_test@gmail.com\",\n \"createdAt\": \"1768397583005\",\n \"status\": \"ACCEPTED\"\n }\n ],\n \"contactRequests\": [],\n \"notifications\": [],\n \"analytics\": {\n \"userActivityCount\": 3,\n \"userDataCount\": 3\n }\n}"}],"_postman_id":"429a5e8c-1741-4dc4-997f-fc7d2ad08a8d"},{"name":"purge customer data","event":[{"listen":"test","script":{"id":"1c46b9c5-eae2-48d2-ac00-51117d9562ba","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json().edges[0].node.id;","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"306ee68f-a4d0-41aa-8294-365724ec5635","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/data","description":"

Purge Customer Data

Permanently deletes all privacy-related data associated with a customer account. This endpoint is used to fulfill \"right to be forgotten\" requests and ensure complete data deletion in compliance with privacy regulations.

Endpoint

DELETE https://api.botbye.com/api/v1/{account_id}/privacy/data\n

Required Variables

base_url: The base URL for the BotBye API
account_id: Your unique account identifier

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a confirmation response indicating successful deletion of customer data.

⚠️ Warning

This action is irreversible. Once customer data is purged, it cannot be recovered. Ensure you have:

Verified the deletion request is legitimate
Completed any required data exports
Obtained necessary approvals
Documented the deletion for compliance records

Use Cases

GDPR Right to Erasure: Fulfill Article 17 deletion requests
CCPA Deletion Rights: Comply with California Consumer Privacy Act requirements
Account Closure: Remove all data when a customer closes their account
Data Retention Compliance: Delete data that has exceeded retention periods

Best Practices

Always retrieve and backup data using the GET endpoint before deletion
Maintain audit logs of deletion requests
Verify the request authenticity before executing
Confirm deletion completion with the customer

Data Scope

This endpoint removes all customer-related data including:

Personal information
Account details
Historical records
Associated metadata
Activity logs

\n","urlObject":{"path":["api","v1","{account_id}","privacy","data"],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"f727e588-806e-40a1-999e-7e5311f98f90","name":"purge customer data","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/data"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"227"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{}"}],"_postman_id":"306ee68f-a4d0-41aa-8294-365724ec5635"},{"name":"purge end user data","event":[{"listen":"test","script":{"id":"1c46b9c5-eae2-48d2-ac00-51117d9562ba","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json().edges[0].node.id;","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f9fad6f0-872c-4aa8-8e02-2d1084d03e08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/end-users//","description":"

Purge End User Data

Permanently deletes all privacy-related data for a specific end user identified by their server key and account ID. This endpoint enables granular data deletion for individual end users while maintaining data for other users.

Endpoint

DELETE https://api.botbye.com/api/v1/{account_id}/privacy/end-users//\n

Required Variables

base_url: The base URL for the BotBye API
account_id: Your unique account identifier
server_key: The server key associated with the end user
end_user_account_id: The unique identifier for the specific end user to be deleted

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a confirmation response indicating successful deletion of the specified end user's data.

⚠️ Warning

This action is irreversible. Once end user data is purged, it cannot be recovered. This operation:

Permanently removes all data for the specified end user
Does not affect other end users' data
Cannot be undone or reversed

Use Cases

Individual Deletion Requests: Fulfill specific end user's right to erasure
Selective Data Removal: Delete data for specific users without affecting others
Privacy Compliance: Respond to individual GDPR/CCPA deletion requests
Data Minimization: Remove unnecessary end user data
User Opt-Out: Honor end user requests to stop data collection and remove existing data

Best Practices

Retrieve end user data using the GET endpoint before deletion
Verify the server_key and end_user_account_id are correct
Document the deletion request with timestamps and request details
Maintain compliance records of the deletion
Confirm the deletion was successful by checking the response

Data Scope

This endpoint removes all end user-specific data including:

End user profile information
Behavioral and tracking data
Session history
Associated metadata
Activity timestamps

Notes

The granular nature of this endpoint allows you to maintain data isolation and delete specific end user data without impacting your broader customer account or other end users.

\n","urlObject":{"path":["api","v1","{account_id}","privacy","end-users","",""],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"dadcb858-6f56-431a-bb40-5695a36fa30e","name":"purge end user data","originalRequest":{"method":"DELETE","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/end-users//"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"f9fad6f0-872c-4aa8-8e02-2d1084d03e08"},{"name":"get end user privacy data","event":[{"listen":"test","script":{"id":"1c46b9c5-eae2-48d2-ac00-51117d9562ba","exec":["// Stores the project id in an environment or global variable","var projectId = pm.response.json().edges[0].node.id;","pm.collectionVariables.set(\"project_id\", projectId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"49e62763-24ac-4ace-b30b-73e9d616a489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/end-users//","description":"

Get End User Privacy Data

Retrieves all privacy-related data for a specific end user identified by their server key and account ID. This endpoint provides granular access to individual end user data for compliance and transparency purposes.

Endpoint

GET https://api.botbye.com/api/v1/{account_id}/privacy/end-users//\n

Required Variables

base_url: The base URL for the BotBye API
account_id: Your unique account identifier
server_key: The server key associated with the end user
end_user_account_id: The unique identifier for the specific end user

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a JSON object containing all privacy-related data for the specified end user, including:

End user profile information
Behavioral data
Session information
Associated tracking data
Timestamps and metadata

Use Cases

Individual DSAR Requests: Respond to specific end user data access requests
User Data Portability: Export end user data for transfer to another service
Privacy Audits: Review data collected for specific users
Support Investigations: Access user data for troubleshooting or support cases

Notes

This endpoint requires both the server key and end user account ID to ensure proper authorization and data isolation between different end users.

\n","urlObject":{"path":["api","v1","{account_id}","privacy","end-users","",""],"host":["https://api.botbye.com"],"query":[],"variable":[]}},"response":[{"id":"a190dcd9-b016-4cd9-a9de-7993ac015ad4","name":"get end user privacy data","originalRequest":{"method":"GET","header":[],"url":"https://api.botbye.com/api/v1/{account_id}/privacy/end-users//"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"432"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"serverKey\": \"a25e67d6-8b41-4155-8b8e-09ff313a18da\",\n \"accountId\": \"9bdaad6a-bd98-4c0e-95e2-3241d68d4a85\",\n \"activity\": {\n \"eventCount\": 3,\n \"firstActivity\": \"2026-02-02 12:47:49.63\",\n \"lastActivity\": \"2026-02-10 15:03:41.13\",\n \"ips\": [\n \"0.0.0.0\"\n ],\n \"countries\": [],\n \"userAgents\": [\n \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36\"\n ],\n \"emails\": [\n \"jhon_test@gmail.com\"\n ],\n \"phones\": [],\n \"usernames\": [\n \"Jhon\"\n ]\n }\n}"}],"_postman_id":"49e62763-24ac-4ace-b30b-73e9d616a489"}],"id":"469f7383-b88b-4ec2-9281-64cdf0c4d998","description":"

Privacy Management

This folder contains endpoints for managing privacy-related data in compliance with data protection regulations (GDPR, CCPA, etc.). These endpoints allow you to retrieve and purge personal data for both customers and end users.

Overview

The Privacy API provides two main capabilities:

Data Retrieval: Access privacy-related data for customers and end users
Data Purge: Permanently delete personal data to fulfill data deletion requests

Authentication

All requests require API key authentication. Set your api_key variable in the collection or environment variables.

Common Variables

base_url: The base URL for the API
account_id: Your account identifier
server_key: Server key for end user operations
end_user_account_id: Unique identifier for the end user

Use Cases

Responding to data subject access requests (DSAR)
Fulfilling \"right to be forgotten\" requests
Auditing stored personal data
Compliance reporting and data inventory

\n","_postman_id":"469f7383-b88b-4ec2-9281-64cdf0c4d998","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]},"isInherited":true,"source":{"_postman_id":"dfffe03f-e114-41dc-8949-f764f2aa0135","id":"dfffe03f-e114-41dc-8949-f764f2aa0135","name":"BotBye project API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{api_key}"}]}},"event":[{"listen":"prerequest","script":{"id":"078b5e8f-ae57-4b66-915b-7b07c8fdc66f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b0dc3475-8979-4459-93d6-9ee9bcec01b3","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.botbye.com","type":"string"},{"key":"account_id","value":"{account_id}"},{"key":"api_key","value":"{api_key}"},{"key":"project_id","value":"{project_id}"},{"key":"rate_limiter_id","value":"{rate_limiter_id}","type":"string"},{"key":"rule_id","value":"{rule_id}","type":"string"},{"key":"project_member_id","value":"{project_member_id}"},{"key":"acl_group_id","value":"{acl_group_id}"},{"key":"acl_rule_id","value":""},{"key":"account_member_id","value":"{account_member_id}"},{"key":"id","value":"{id}","type":"string"},{"key":"server_key","value":"","type":"default"},{"key":"end_user_account_id","value":"","type":"default"}]}

Request

Query Parameters:

GET /api/v1/{account_id}/projects/{project_id}

Request

Response

GET /api/v1/{account_id}/projects/{project_id}

Request

Response

GET /api/v1/{account_id}/projects/{project_id}

Request

Response

GET /api/v1/{account_id}/projects/{project_id}

Request

Response

GET /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

Request

Response

DELETE /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

Request

Response

PATCH /api/v1/{account_id}/projects/{project_id}/rate_limiters/order

Request

Response

PATCH /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active

Request

Request Body

Response

PUT /api/v1/{account_id}/projects/{project_id}/rate_limiters

Request

Response

POST /api/v1/{account_id}/projects/{project_id}/rate_limiters

Request

Response

GET /api/v1/{account_id}/projects/{project_id}/rules/{rule_id}

Request

Response

DELETE /api/v1/{account_id}/projects/{project_id}/rules/{rule_id}

Request

Response

PATCH /api/v1/{account_id}/projects/{project_id}/rules/order

Request

Response

Update Rule Active Status

Request

Request Body

Response

Update Project Rules

Create Project Rule

Request Body

Response

Get Requests Overview

Endpoint

Authentication

Path Parameters

Query Parameters

Response Structure

Example Response

Use Cases

Important Notes

Get Declined Requests Count

Endpoint

Authentication

Path Parameters

Query Parameters

Response Structure

Example Response

Use Cases

Understanding Trends

Important Notes

Get Declined Requests Summary

Endpoint

Authentication

Path Parameters

Query Parameters

Response Structure

Common Properties (All Summary Types)

Summary Type: attack_source

Summary Type: country

Summary Type: endpoint

Summary Type: reason

Summary Type: `attack_source`

Summary Type: `country`

Summary Type: `endpoint`

Summary Type: `reason`

Summary Type: `rule`