Available Fields for the Reporting Publishers

By default, all the fields listed in the following tables are exported. However, for the CSV publisher, you can configure the export to only include a subset of these published fields.

This page discusses:

See Also
About Reporters
Output Reporting Data to CSV Files
Output Reporting Data to a JDBC Database
Output Reporting Data to the Internal SQLite Database
Index Reporting Data as a Data Source

Search Reporting Fields

Table 1. search-reporting Query Fields

Field Name

Type

Description

timestamp

datetime

The date and time of the export of the data.

apiclient_ip

string

IP address of the client for this API request.

query_logic

string

Search logic used for the query.

query_target

string

Search target used for the query.

query_querystring

string

The UQL query (q=) entered by the user. This is the same as the _default_ value for the query template defined in searchLogicList.xml.

query_language

string

ISO language code

query_start

unsigned integer

First requested full hit.

query_hf

unsigned integer

Number of requested full hits.

query_origin

string

Explains "what" created this request: page load on Mashup UI; AJAX load on Mashup UI; trusted queries; cache warm-up; isAlive; alerting; and so forth.

answer_nmatches

unsigned integer

Total number of matches.

answer_nhits

unsigned integer

Number of hits.

time_total

unsigned integer

Total query time in microseconds.

query_full

string

Full query parameters in URL form.

query_id

unsigned integer

Auto-assigned internal query ID.

spellcheck_enabled

Boolean

Was spellcheck enabled on this query?

spellcheck_suggestions

unsigned integer

Number of spellcheck suggestions.

spellcheck_autocorrect

Boolean

Was autocorrect enabled?

spellcheck_autocorrected

Boolean

Was autocorrect triggered?

applicationId

string

Mashup application ID passed by the API client.

user_id

string

User ID passed by the API client.

usersession_id

string

Session ID passed by the API client.

userquery_id

string

Query ID passed by the API client.

processing_indexquery

string

ELLQL query

answer_status

unsigned integer

Answer status. 0=ok, 1=error, 2=timeout, 3=limit reached

time_queue

unsigned integer

Time in query processing queue in microseconds.

time_queryprocessing

unsigned integer

Time for query parsing and processing in microseconds.

time_exec

unsigned integer

Time for partial hits execution in microseconds.

time_synfh

unsigned integer

Time for synthesis and full hits execution in microseconds.

cputime_queryprocessing

unsigned integer

CPU time for query parsing and processing in microseconds.

cputime_exec_searcher

unsigned integer

CPU time for partial hits execution, searcher side, in microseconds.

cputime_exec_index

unsigned integer

CPU time for partial hits execution, index side, in microseconds.

cputime_synthesis_searcher

unsigned integer

CPU time for synthesis execution, searcher side, in microseconds.

cputime_synthesis_index

unsigned integer

CPU time for synthesis execution, index side, in microseconds.

cputime_fullhits_searcher

unsigned integer

CPU time for full hits execution, searcher side, in microseconds.

cputime_fullhits_index

unsigned integer

CPU time for full hits execution, index side, in microseconds.

searchserver

string

The search server that processed this query.

expansion_languages

string

Language detected at search-time for the expansion.

Suggest Reporting Fields

Table 2. suggest-reporting Fields

Field name

Type

Description

timestamp

datetime

The date and time of the export of the data.

apiclient_ip

string

IP address of the client for this API request.

query_service

string

Name of the suggests or dispatchers called.

query_querystring

string

The UQL query (q=) entered by the user. This is the same as the _default_ value for the query template defined in searchLogicList.xml.

query_output

string

output format: JSON or XML.

query_full

string

Full query parameters in URL form.

answer_status

Boolean

0 = OK, 1 = error

answer_nhits

unsigned integer

Number of suggestions returned.

answer_blacklisted

unsigned integer

Number of removed suggestions.

time_total

unsigned integer

Total query time in microseconds.

query_distance

unsigned integer

Approximate matching. The greater the distance, the more approximate the match. 0 for exact match.

query_cursor_pos

unsigned integer

The cursor position.

query_recursive

Boolean

Was the query processed recursively?

query_autocomplete

Boolean

Was the original query auto-completed?

query_min_d1

unsigned integer

If distance >= 1: minimum entry length to perform approximative suggestions with distance set to 1.

query_min_d2

unsigned integer

If distance >= 2: minimum entry length to perform approximative suggestions with distance set to 2.

query_logic

string

Search logic used for the query.

query_callback

string

The javascript callback that was called.

query_exhaustive

Boolean

Did the output contain exhaustive information?

searchserver

string

The search server that processed this query.

Mashup UI & Mashup API Reporting Fields

These are the fields that can be applied for both mashup-ui-reporting and mashup-api-reporting.

Table 3. mashup-ui-reporting & mashup-api-reporting Fields

Field name

Type

Description

timestamp

datetime

The date and time of the export of the data.

user_id

string

User ID passed by the API client.

application_id

unsigned integer

Auto-assigned internal application ID.

report_id

unsigned integer

Auto-assigned internal report ID.

component_type

string

Indicates the reported component types. For example, Page, PreRequestTrigger, Widget, MashupWidgetTrigger, etc.

component_name

string

Indicates the names of all the components that can be found on the page, that is to say the name of the page itself, the widget names and the trigger names.

component_event

string

Indicates the event types. For example, render, before_query, after_query, before_rendering, after_rendering, etc.

start_cpu

unsigned integer

CPU start time value in microseconds for each page component event.

stop_cpu

unsigned integer

CPU stop time value in microseconds for each page component event.

start_nanotime

unsigned integer

Real start execution-time value in nanoseconds for each page component event.

stop_nanotime

unsigned integer

Real stop execution-time value in nanoseconds for each page component event.

service_instance

string

Mashup UI or Mashup API instance name (as specified in Deployment > Roles).

For example, mu0 for Mashup UI and ac0 for Mashup API.

user_session

string

Auto-assigned internal user session ID.

query_querystring

string

The full query string received by the page or the Mashup API.

client_ip

string

The web client (browser) IP address.

client_user_agent

(for mashup-ui-reporting only)

string

The web client (browser) user agent.

client_accept_language

(for mashup-ui-reporting only)

string

The web client (browser) default language.

response_size

unsigned integer

The web client (browser) or the Mashup API response size in bytes.

opendocs Reporting Fields

Table 4. opendocs-reporting Fields

Field name

Type

Description

timestamp

datetime

The date and time of the export of the data.

document_source

string

The connector name.

document_uri

string

The document URI that was downloaded or previewed.

document_filename

string

The document file name that was downloaded or previewed.

user_id

string

User ID passed by the API client.

application_id

string

The name of the mashup UI application on which documents were downloaded or previewed.

query_querystring

string

The UQL query (q=) entered by the user. This is the same as the _default_ value for the query template defined in searchLogicList.xml.

query_queryfull

string

Full query parameters in URL form.

buildgroup

string

The name of the build group in which the document is indexed.

type

string

The type of action that was executed: Download or Preview.