saved_search.create - Fluid Topics - Latest

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

This server event occurs when a SAVED_SEARCH_USER user saves a search.

This event contains the following fields:

Field Description
savedSearch An object containing information about the saved search.
id The saved search's identifier.
name The saved search's name.
searchQuery Information about the query.
terms The terms included in the query.
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 search type. Can be EVERYWHERE, TITLE_ONLY, NONE, or null.
alert Information about whether an alert was configured for the search.
  • Since this event originates from the server and not the web application, it is not possible to listen to it.
  • The lastUpdate field is deprecated. Information regarding the last update is included in the DATE or RANGE type of the ft:lastEdition facet.

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

Example:

[
    {
        "savedSearch": {
            "id": "dd65d1c6-a3cb-4818-9a19-3cffbd426a6e",
            "name": "Alert on Fluid Topics integration guide modification",
            "searchQuery": {
                "terms": "",
                "facets": [
                    {
                        "key": "ft:publicationId",
                        "type": "VALUE" 
                        "values": [
                            "Cixf6Ly_Kc5SpgUBf1vV_Q"
                        ]
                    },
                    {
                        "key": "Product", 
                        "type": "VALUE", 
                        "values": [
                            "Fluid Topics"
                        ]
                    },
                    {
                        "key": "ft:lastEdition", 
                        "type": "DATE", 
                        "dateValue": "LAST_MONTH"
                    },
                    {
                        "key": "FT_Version", 
                        "type": "RANGE", 
                        "from": "5.0", 
                        "to": "5.1"
                    }
                ],
                "searchType": "EVERYWHERE"
            },
            "alert": false
        }
    }
  }
]