...
Field | Data type | Description | |||||
---|---|---|---|---|---|---|---|
id | Unique Identifier | Internal item identifier, generated by Squirro only. | |||||
external_id | String | External item identifier. The external identifier is used for deduplication and can be used to link items to their source system. See the | |||||
read | Boolean | True if the item has been read. | |||||
starred | Boolean | True if the item has been starred. | |||||
abstract | Text String | Item abstract. This is generated from the In case the item is returned as a matching result to a query search, the abstract is calculated around the most relevant matching keywords. | |||||
score | Float | Relevant score of the item. This is only set when the result list is ordered by relevance. | |||||
thumbler_url | Partial URL | Used internally by Squirro to display thumbnails of the webshot_url field. | |||||
explanation | Dictionary | Returned for items when the Example:
| |||||
related_items | List | Returned when the Example:
| |||||
sub_items | |||||||
highlight_matches | |||||||
highlight_matches | Dictionary | A dictionary of matching query terms per field.
| |||||
matching_sub_items | List | List of sub-items (e.g. pages for a PDF) with matches for the current query. | |||||
has_matching_sub_items | |||||||
sources | |||||||
objects | Boolean | True if the item consists of sub-items (e.g. pages for a PDF) that matches the current query. | |||||
subscriptions | List | Returns a list of subscription details.
| |||||
objects | List | Returns a list of object details.
|