collection.create - Fluid Topics - Latest

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

This server event occurs when a COLLECTION_USER user creates a collection.

This event contains the following fields:

Field Description
collection An object containing information about the collection.
id The collection's identifier.
name The collection's name.
searchQuery Information about the query if the collection was created by saving the results of a search. null if the collection was not created this way.
terms The terms included in the query.
facets The list of facets applied at query time. Can be null.
lastUpdate The selected period at query time. Can be LAST_WEEK, LAST_MONTH, LAST_YEAR, CUSTOM, or null.
searchType The search type. Can be EVERYWHERE, TITLE_ONLY, NONE, or null.
documents An object containing information about the documents in static collections.
id The ID of the documents in the collection.
title The title of the documents in the collection.
type The documents' type (for example, STRUCTURED_DOCUMENT).
  • For swift collections, the documents field is empty.
  • Since this event originates from the server and not the web application, it is not possible to listen to it.

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

Example:

[
    {
        "collection": {
            "id": "bfe5a4f6-40e7-40e9-b1f8-3e0f782b994f",
            "name": "Example-Collection",
            "searchQuery": {
                "terms": "API",
                "facets": [
                    {
                        "key": "Version_FT",
                        "values": [
                            "Latest"
                        ]
                    }
                ],
                "searchType": "EVERYWHERE"
            },
        "documents": []
        }
    }
]