Get Similar Entries Endpoint
Overview
The Get Similar Entries API retrieves entries similar to a specified entry. Similarity is computed using the L2 (Euclidean) distance between selected fields within a source where the is_indexed flag is set to true.
Note: You must build a similarity index before using this endpoint.
Endpoint
GET https://api.myboardtoday.com/app/:app_id/source/:source_id/entry/:entry_id/similar
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | UUID | Yes | Unique identifier of the app. |
source_id | UUID | Yes | Unique identifier of the data source. |
entry_id | UUID | Yes | Unique identifier of the entry to compare. |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
k | Integer | No | 5 | Number of top similar entries to return. |
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | API key used for authentication. |
Response
Returns a JSON object containing the list of similar entry UUIDs and their corresponding L2 distances.
Example Response
{
"distance": [5, 4, 3, 2, 1],
"similar_items": ["uuid1", "uuid2", "uuid3", "uuid4", "uuid5"]
}
distance: An array of numerical L2 distances, ordered from least to greatest.similar_items: An array of entry UUIDs representing the most similar entries.
Report Bugs, Request New Features, and Win $50 Every Month
We value your precious feedback. Please contact us when you find a bug or would like to request a new feature. (In the main panel, click on the bob logo on the top left corner, then in the Dropdown menu click on “contact for bugs or new features”). Every month we will select an “opinion leader” and reward him/her with $50 in cash.