search_page.select - Fluid Topics - Latest

Integrate the Fluid Topics API
Category
Technical Notes
Audience
public
Version
Latest

This web application event occurs when any user opens a search result.

Fluid Topics does not log a search_page.select event if a user previews a search result without opening it.

This event contains the following fields:

Field Description
searchQuery An object containing information about the search query.
terms Contains the keywords the user searched for.
facets An object containing information about the search facets.
key The metadata key used as facet.
type Takes one of the following values: VALUE, DATE, RANGE.
value The facet value.
searchType The type of search. Accepts the following values: EVERYWHERE, TITLE_ONLY, NONE.
externalLink Link to the document in case of an external document.
searchResult An object containing information about the search result.
rank The rank of the result in the list of search results.
type The type of the result (MAP, DOCUMENT, or TOPIC).
document An object containing information about the document.
id The document's identifier.
title The document's title.
type The document's type (for example, STRUCTURED_DOCUMENT).
metadata A list of the document's metadata with the label and values of each key.
topic Contains the information about the topic, if the value for the searchResult parameter is TOPIC.
title The topic's title.
tocId The topic's tocId.

A table for the most common fields is in Analytics events.

Example:

[
  {
    "searchQuery": {
      "terms": "afs_search_build",
      "facets": [],
      "searchType": "EVERYWHERE"
    },
    "searchResult": {
      "rank": 1,
      "type": "TOPIC",
      "document": {
        "id": "MUTHQr7DBstGQbqa1sJGhw",
        "title": "AFS Filters Description",
        "type": "STRUCTURED_DOCUMENT",
        "metadata": [
          {
            "key": "Product",
            "label": "Product",
            "values": [
              "AFS"
            ]
          },
          {
            "key": "AFS_Version",
            "label": "Plateforme",
            "values": [
              "7.14"
            ]
          },
          {
            "key": "Category",
            "label": "Category",
            "values": [
              "Reference Guides"
            ]
          }
        ]
      },
      "topic": {
        "tocId": "G2GwZCFvFIWkaGsasfWMNw",
        "title": "afs_search_build"
      }
    }
  }
]

The externalLink field only appears when a user selects an external document.