FBT
How to perform an FBT query and how it works
Request
To perform an FBT query send a POST
request to the /analysis/fbt
endpoint specifying the item ID(s) in the filter without any extra query keys:
Operator | Type | Description | Example |
---|---|---|---|
| Array | A list of SKU or bundle IDs associated as line items to one or more orders. |
|
Please note that while the attribute value of the in
operator used in the standard filters matches any (logic OR
) of the specified array's values, the attribute value of the in
operator used in the FBT filters matches all (logic AND
) of the specified array's values.
The filter
object is required (if missing the API will respond with a 400 Bad request
error). You can optionally add the meta object for any useful information about the query itself (learn more here).
Response
The response of an FBT query returns an aggregation by item ID ordered by value (e.g. from the most frequently bought together item to the less frequently bought together item), with some additional information:
Key | Type | Description |
---|---|---|
| String | The ID of the item associated with the line item. |
| Integer | The number of orders containing both the item identified by the |
| String | The type of the item identified by the |
| String | The name of the line item (as in the first created order among the ones counted in the |
The FBT query returns a maximum of 10 records (i.e. the 10 most frequently bought together items).
Example
The following request performs an FBT query to get the items most frequently bought together with the item identified by the ID "BmDzSVkXAW":
Last updated