document.search - Fluid Topics - Latest

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

This web application event occurs when any user searches in a document and the replies have been retrieved.

This event contains the following fields:

Field Description
document An object containing information about the document.
    id The document's identifier.
    metadata A list of the document's metadata with the label and values of each key.
    title The title of the document.
    type The document's type (for example, STRUCTURED_DOCUMENT).
searchQuery An object containing information about the search query.
    terms Contains the keywords the user searched for.
searchResponse An object containing information about the search response.
    nbResults Contains the number of results retrieved for the search query.

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

Example:

[
   {
        "appName": "ft/turnkey-portal",
        "appVersion": "4.3.2",
        "contentLocale": "en-US",
        "datetime": 1704201973366,
        "id": "c59db1d4-ac17-4372-abc8-63290281342f",
        "name": "document.search",
        "offline": false,
        "parameters": {
            "document": {
                "id": "L3k_Hu_CJ8lN1UrzoZPM4Q",
                "title": "Analytics for Fluid Topics",
                "type": "STRUCTURED_DOCUMENT",
                "metadata": [
                    {
                        "key": "Product",
                        "label": "Product",
                        "values": [
                            "Fluid Topics"
                        ]
                    },
                    {
                        "key": "Version_FT",
                        "label": "Fluid Topics Version",
                        "values": [
                            "Latest"
                        ]
                    },
                    {
                        "key": "Category",
                        "label": "Category",
                        "values": [
                            "Technical Notes"
                        ]
                    },
                    {
                        "key": "audience",
                        "label": "Target Audience",
                        "values": [
                            "public"
                        ]
                    }
                ]
            },
            "searchQuery": {
                "terms": "Traffic by country"
            },
            "searchResponse": {
                "nbResults": 44
            }
        },
        "sessionId": "74f1ae74-65ee-4e1e-a7b9-1aac1521aaf8",
        "tenantId": "1-stable",
        "uiLocale": "en-US",
        "user": {
            "groups": [
                "ft:administrator",
                "ft:authenticated"
            ],
            "id": "d554325-eef7-4850-93c1-cea73446582060",
            "roles": [
                "HTML_EXPORT_USER",
                "PDF_EXPORT_USER",
                "PERSONAL_BOOK_USER",
                "FEEDBACK_USER",
                "PERSONAL_BOOK_SHARE_USER",
                "OFFLINE_USER",
                "ADMIN",
                "COLLECTION_USER",
                "SAVED_SEARCH_USER",
                "PRINT_USER",
                "RATING_USER"
            ]
        },
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
        "userIp": "192.168.2.3"
    }
]