Requirements for Reports and Dashboards

App Insights is deprecated in Fusion 5.12.

Although there are many fields that are relevant to signals, this topic describes which fields are required for each type of signal. Without these fields, reports and dashboards may not function as expected.

Report Signal Types Used Required Field Type Description Example

Report	Signal Types Used	Required Field	Type	Description	Example
Search queries	✘ Annotation ✅ Click ✘ Login ✅ Request ✅ Response	`query`	string	Terms of the query.	`physics`
Facets used	✘ Annotation ✘ Click ✘ Login ✅ Request ✘ Response	`filter_field`	array of string	List of filters associated with the query, which in turn is associated with signal.	`["categories_s"]`
Facet filters applied	✘ Annotation ✘ Click ✘ Login ✅ Request ✘ Response	`filter`	array of string	List of applied filters associated with the query, which in turn is associated with signal.	`["categories_s/math.OA"]`
Application servers	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`host`	string	Host name of the server that is hosting the app, which in turn is generating the signal.	`lucidworks`
Response times	✘ Annotation ✘ Click ✘ Login ✘ Request ✅ Response	`time`	number	Response time (in milliseconds).	`17`
URLs clicked	✘ Annotation ✅ Click ✘ Login ✘ Request ✘ Response	`url`	string	URL of the page that was selected from the search results. This typically results from a click signal.	`http://arxiv.org/pdf/astro-ph/0611688v1`
Search pages	✘ Annotation ✘ Click ✘ Login ✅ Request ✘ Response	`page_title`	string	Title of the page that the signal originated from.	`Search Preview`
Search platforms	✘ Annotation ✅ Click ✘ Login ✅ Request ✅ Response	`platform`	string	Name of the search platform.	`fusion`
Visitor countries	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`geo_country_name`	string	Originating country of the user.	`United States`
Visitor cities	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`geo_city_name`	string	Originating city of the user.	`San Francisco`
Browsers	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`browser_name`	string	Name of the browser that generated the signal.	`Firefox`
Operating System	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`os_name`	string	Name of the operating system used by the user.	`Ubuntu`
Device types	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`os_device`	string	Type of the device used by the user.	`Computer`
Websites people are coming from	✘ Annotation ✅ Click ✘ Login ✘ Request ✘ Response	`referrer_domain`	string	URL of the page that the signal originated from.	`http://www.google.com`
Users	✘ Annotation ✅ Click ✘ Login ✅ Request ✘ Response	`user_id`	string	Unique ID for the user that generated the signal.	`admin`
User domains	N/A	`domain`	string	Domain of the user that generated the signal.	`lucidworks.com`
Types of event	✅ Annotation ✅ Click ✅ Login ✅ Request ✅ Response	`type`	string	Type of the signal.	`click`
Head Tail analysis	✘ Annotation			This report is populated by running a head tail job in Fusion. With a collection called `foo`, for example, run the `foo_head_tail` job.	N/A
✅ Click	type	string	N/A
✅ Click	query	string	N/A
✘ Login			N/A
✘ Request			N/A
✅ Response	count_i	number	N/A

Search queries

✘ Annotation

✅ Click

✘ Login

✅ Request

✅ Response

query

string

Terms of the query.

physics

Facets used

✘ Annotation

✘ Click

✘ Login

✅ Request

✘ Response

filter_field

array of string

List of filters associated with the query, which in turn is associated with signal.

["categories_s"]

Facet filters applied

✘ Annotation

✘ Click

✘ Login

✅ Request

✘ Response

filter

array of string

List of applied filters associated with the query, which in turn is associated with signal.

["categories_s/math.OA"]

Application servers

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

host

string

Host name of the server that is hosting the app, which in turn is generating the signal.

lucidworks

Response times

✘ Annotation

✘ Click

✘ Login

✘ Request

✅ Response

time

number

Response time (in milliseconds).

17

URLs clicked

✘ Annotation

✅ Click

✘ Login

✘ Request

✘ Response

url

string

URL of the page that was selected from the search results. This typically results from a click signal.

http://arxiv.org/pdf/astro-ph/0611688v1

Search pages

✘ Annotation

✘ Click

✘ Login

✅ Request

✘ Response

page_title

string

Title of the page that the signal originated from.

Search Preview

Search platforms

✘ Annotation

✅ Click

✘ Login

✅ Request

✅ Response

platform

string

Name of the search platform.

fusion

Visitor countries

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

geo_country_name

string

Originating country of the user.

United States

Visitor cities

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

geo_city_name

string

Originating city of the user.

San Francisco

Browsers

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

browser_name

string

Name of the browser that generated the signal.

Firefox

Operating System

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

os_name

string

Name of the operating system used by the user.

Ubuntu

Device types

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

os_device

string

Type of the device used by the user.

Computer

Websites people are coming from

✘ Annotation

✅ Click

✘ Login

✘ Request

✘ Response

referrer_domain

string

URL of the page that the signal originated from.

http://www.google.com

Users

✘ Annotation

✅ Click

✘ Login

✅ Request

✘ Response

user_id

string

Unique ID for the user that generated the signal.

admin

User domains

N/A

domain

string

Domain of the user that generated the signal.

lucidworks.com

Types of event

✅ Annotation

✅ Click

✅ Login

✅ Request

✅ Response

type

string

Type of the signal.

click

Head Tail analysis

✘ Annotation

This report is populated by running a head tail job in Fusion. With a collection called foo, for example, run the foo_head_tail job.

N/A

✅ Click

type

string

N/A

✅ Click

query

string

N/A

✘ Login

N/A

✘ Request

N/A

✅ Response

count_i

number

N/A

The fields mentioned above are defined as follows:

Field Name Example Value Description

Field Name	Example Value	Description
`count_i`	1	Number of times an interaction event occurred with this item
`doc_id`	NMDDV	Product ID or Item ID
`query`	xwearabletech	A query string from the user
`session_id`	91aa66d11af44b6c90ccef44d055cf9a	Id for session in which user generated the signal
`type`	quick_view_click	Type of session the user used to interact with the platform
`user_id`	11506893	ID of user during the session
`timestamp_tdt`	2018-11-20T17:58:57.650Z	Time when signal was generated

count_i

Number of times an interaction event occurred with this item

doc_id

NMDDV

Product ID or Item ID

query

xwearabletech

A query string from the user

session_id

91aa66d11af44b6c90ccef44d055cf9a

Id for session in which user generated the signal

type

quick_view_click

Type of session the user used to interact with the platform

user_id

11506893

ID of user during the session

timestamp_tdt

2018-11-20T17:58:57.650Z

Time when signal was generated

Some signal types, including custom signal types, may include additional fields.