Trigger interface analytics events - Fluid Topics

Trigger interface analytics events - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category

Reference Guides

Audience

public

Version

Latest

This web service triggers events on the UI side.

It is possible to activate interaction tracking using the following:

Custom components within the Fluid Topics portal.
Applications or interfaces using Fluid Topics web services including those running fully or partially outside Fluid Topics portals.

It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.
Only the events triggered in the interface require reporting via this web service. Events triggered on the server side are tracked natively.

Method	Endpoint
`POST`	`/api/analytics/events`

Request example

The following example shows an analytics event for a knowledge based search:

[
  {
    "offline": false,
    "appName": "ft-integration",
    "appVersion": "1.0",
    "name": "custom_event.trigger",
    "eventName": "MyCustomEventName",
    "componentId": "button-contact1",
    "page": {
      "id": "ft/home",
      "type": "homePage",
      "url": "/",
      "name": "home",
      "language": "en-US"
    }
  }
]

Field	Type	Required?	Description
`offline`	Boolean	Yes	Indicates whether the event was triggered while being offline (`true` or `false`).
`appName`	String	Yes	The name of the application triggering the event.
`appVersion`	String	Yes	The version of the application triggering the event.
`name`	String	Yes	The name of the analytics event.
`eventName`	String	Yes	The name of the custom event.
`componentId`	String	Yes	The name of the component triggering the event.
`Page`	Object	Yes	An object containing information about the page the custom event is triggered from.
`id`	String	Yes	The page's identifier.
`type`	String	Yes	The page's type. The type can be `designedHomePage`, `designedPage`, `designedReaderPage`, `designedSearchPage`, `homePage`, `readerPage`, `searchPage`, `viewerPage`.
`url`	String	Yes	The URL path used to access the page.
`name`	String	Yes	The page's name.
`language`	String	Yes	The language defined for the page if it is a designed page.

Different events may have different fields. See the Interface events section for more information.