API Reference
Last updated
Was this helpful?
Last updated
Was this helpful?
filter
Filter
Object containing filtering rules which will evaluate against context object. Filter can be an instance of 5 different filter types described below.
type
group
Filter group will evaluate by applying a logical operation to the array of filters provided
filters
Filter[]
Array of filters
operator
enum(and
, or
)
Logical operation
Use this endpoint to get the list of enabled features for the user. The response will contain the list of features that are enabled for the user.
/features/enabled
Context object has to be flattened and delimited by dots and provided as query parameters. Example:
context.company.id=42&context.user.id=99
Feature key - unique identifier of the feature which you can find in app.bucket.co Example:
new-order-created
Use this endpoint to get the list of all features evaluated for the user.
/features/evaluated
Context object has to be flattened and delimited by dots and provided as query parameters. Example:
context.company.id=42&context.user.id=99
Feature key - unique identifier of the feature which you can find in app.bucket.co Example:
new-order-created
Use this endpoint to send feature events to Bucket.
/features/events
Feature key - unique identifier of the feature which you can find in app.bucket.co Example:
new-order-created
The version of the targeting rules. Every time when targeting rules are updated the version is incremented.
Context object has to be flattened and delimited by dots and provided as query parameters. Example:
context.company.id=42&context.user.id=99
The result of the evaluation
evaluate
, check
The results of evaluation for each of the rules
The fields that were missing in the context for successful evaluation
Use this endpoint when you want to send user attributes to Bucket. If the user does not exist, it will be created. This endpoint is also used whenever you construct bucket client in any of the SDKs.
/user
Unique identifier for the user
Additional attributes of the user
Timestamp associated with the user data
Use this endpoint when you want to send company attributes to Bucket. If the company does not exist, it will be created. You can also use this endpoint to assign user to a company by including the user ID. This endpoint is also used whenever you construct bucket client in any of the SDKs.
/company
Identifier for the user linked to the company
Unique identifier for the company
Additional attributes of the company
Timestamp associated with the company data
Use this endpoint when you want to send a tracking events to Bucket.
/event
Identifier for the user initiating the event
The name of the generated event
Additional event-related attributes
Identifier for the company linked to the event
Timestamp associated with the event
Use this endpoint when you want to send feedback events to Bucket.
/feedback
Unique identifier for updating existing feedback
Identifier of the user providing feedback
Identifier of the company linked to the feedback
Identifier of the feedback prompt
Identifier of the feature the feedback is related to
Feature key - unique identifier of the feature which you can find in app.bucket.co Example:
new-order-created
In case the feedback is initiated by a prompt this will be the question which was asked
In case the feedback is initiated by a prompt this will be the question which was asked
The score of the feedback
The user's input
When the feedback was submitted
The source of the feedback
api
, manual
, prompt
, sdk
, widget