Recomms AI
  1. Business Rules
Recomms AI
  • Documentation
  • Recomms AI SDK
  • Items
    • Create an item
      POST
    • Update an item
      PATCH
    • Get items
      GET
    • Get item by ID
      GET
    • Delete item
      DELETE
    • Get item side info
      GET
    • Create item side info
      POST
    • Delete item side info
      DELETE
    • Reset items
      POST
  • Users
    • Create a user
      POST
    • Update a user
      PATCH
    • Get users
      GET
    • Get user by ID
      GET
    • Delete user
      DELETE
    • Get user side info
      GET
    • Create user side info
      POST
    • Delete user side info
      DELETE
    • Reset users
      POST
  • Interactions
    • Record an interaction
      POST
    • Get interactions
      GET
    • Delete an interaction
      DELETE
    • Record multiple interactions
      POST
    • Reset interactions
      POST
  • Business Rules
    • Create a new business rule
      POST
    • List business rules
      GET
    • Get business rule by ID
      GET
    • Update business rule
      PATCH
    • Delete business rule
      DELETE
  • Recommendations
    • Get item recommendations for a user
    • Get user recommendations for an item
    • Get similar users
    • Predict scores for user-item pairs
    • Predict scores for a batch of user-item combinations
    • Search for items
    • Search for users
    • Get top items
  1. Business Rules

Get business rule by ID

GET
https://api.recomms.ai/{database}/business-rules/{id}
Business Rules
Retrieve a specific business rule by its ID from the specified database.

Request

Path Params
database
string 
required
The ID of the database to operate on
id
integer 
required
ID of the business rule

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.recomms.ai//business-rules/'

Responses

🟢200OK
application/json
Successful operation
Body
id
integer 
optional
The unique identifier for the business rule
resource
enum<string> 
optional
The resource type this rule applies to
Allowed values:
usersitems
rule
enum<string> 
optional
The type of rule
Allowed values:
boosterfilter
field
string 
optional
The field this rule applies to
condition
enum<string> 
optional
The condition for the rule
Allowed values:
><>=<===innot incontainsnot contains
value
string 
optional
The value to compare against
enabled
boolean 
optional
Whether the rule is enabled
default
boolean 
optional
Whether this is a default rule
date_created
string <date-time>
optional
The date and time when the rule was created
date_updated
string <date-time>
optional
The date and time when the rule was last updated
Example
{
  "id": 0,
  "resource": "users",
  "rule": "booster",
  "field": "string",
  "condition": ">",
  "value": "string",
  "enabled": true,
  "default": true,
  "date_created": "2019-08-24T14:15:22Z",
  "date_updated": "2019-08-24T14:15:22Z"
}
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-03-13 17:00:15
Previous
List business rules
Next
Update business rule
Built with