search_page.select - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This event contains the following fields:

Field Type Required Description
searchQuery Object yes An object containing information about the search query.
terms String Yes Contains the keywords the user searched for.
facets String No An object containing information about the search facets.
lastUpdate String No Contains the last update value. The value can be LAST_WEEK, LAST_MONTH, LAST_QUARTER, LAST_YEAR or CUSTOM.
searchType String No Contains the scope of the search. The values can be EVERYWHERE,TITLE_ONLY or NONE.
searchResult Object Yes An object containing information about the search result.
rank String Yes The rank of the result in the list of search results.
type String Yes The type of the result (MAP, DOCUMENT, or TOPIC).
document Object Yes An object containing information about the document.
id String Yes The document's identifier.
title String No The document's title.
type String No The document's type. The type can be STRUCTURED_DOCUMENT, UNSTRUCTURED_DOCUMENT, SHARED_PERSONAL_BOOK, PERSONAL_BOOK, ATTACHMENT or RESOURCE.
metadata String No A list of the document's metadata with the label and values of each key.
mimeType String No The format of the downloaded document or attachment.
parentId String No The ID of the parent document when the document is a resource or attachment.
topic Object Yes Contains the information about the topic, if the value for the searchResult parameter is TOPIC.
tocId String Yes The topic's identifier based on its position in the document's table of contents.
title String No The topic's title.
mapId String No The topic's map ID.
mapTitle String No The topic's map title.
metadata String No The topic's metadata.
externalLink String No Link to the document in case of an external document.