Interaction Logs from the Analytics API

Column Name

Description

Data type

nullable?

Notes

LogId

internal ID for each record

bigint

no

InteractionUuid

uuid for each separate interaction

uuid

no

See note on UUID

OriginatingInteractionUuid

for Feedback and Linkclicks, the uuid of the interaction the feedback/linkclick follows on from.

uuid

yes

See note on UUID

SessionUuid

uuid for each separate session

uuid

no

See note on UUID

SessionIsActive

true if any interaction in the session is of a maininteractiontype other than Event or DataRetrieval, or contains only the start of a Dialog and not any other Dialog interaction, otherwise false

boolean

no

TimestampStart

timestamp of the interaction when it entered the Platform, in UTC format

timestamp with time zone

no

TimestampEnd

timestamp of the interaction when it left the Platform, in UTC format

timestamp with time zone

no

Culture

Either the shorter language code, or the full culture code, as applicable for the interaction

text

no

MainInteractionType

The most relevant interactiontype from a recognition perspective -- a user asking a question will have QA here, even if the question is answered using a Dialog

text

no

AllInteractionTypes

All the interactiontypes that were involved in the interaction. A user question that starts a Dialog will have [ "Dialog", "QA"] here

text(json)

no

InteractionValue

A specific value. Depending on the interactiontype, this can be various things but it commonly is the user question or clicked dialog option

text

yes

OutputText

the Answer text returned to the user for this Interaction

text

yes

OutputMetadata

the additional meta-data of the Output, as logged in JSON or a JSON array. Usually an array of key/value pairs.

text (json)

yes

Channel

Information about the Channel for the Answer. {"name": Default, "type":"Text"}

text (json)

no

Contexts

The contexts we logged for this interaction. "id" and "name" should not be empty, "value" can be an empty string.

text (json)

yes

ArticleIds

the articles used to provide an answer to this interaction. ["dn-1-1", "qa-1"]

text (json)

yes

DialogPaths

A json overview of which dialogpaths applied during the interaction.
Started: the location in a dialog that was just started
EndedOrInProgress: the location in an ongoing dialog or one that was ended to start a new one
DropOut: should only appear for interactions not (only) of type Dialog: The location within a Dialog that this interaction dropped out of.

text (json)

yes

TDialogStatus

A JSON object consisting of all the nodes in the Tdialog with the names as keys and whether they are completed (filled with valid data) or not. Completed nodes will have a 1 as the value with the key, Open ones wil have a 0. 

text (json)

yes

FeedbackInfo

All the information relating to a feedback interaction: originatinginteractionuuid, label, score, comment.

text (json)

yes

LinkclickInfo

All the information relating to a linkclick interaction: originatinginteractionuuid, url

text (json)

yes

RecognitionType

What kind of recognition was used for Q&A interactions

text

yes

RecognitionQuality

Only _truly_ relevant for Q&A interactions of recognitiontype 'Entity Recognition'; a measure of how well the question in the CMS that was used to match the user question actually matched that user question, calculated at interaction time.
In the dashboarding, the overall recognition quality is calculated using the Q&A interactions with recognitiontypes 'Entity Recognition', 'No Recognition' (quality is always 0) and 'Exception Event' (quality should always be 100)

numeric

yes

RecognitionDetails

JSON object containing all information about recognition, most notably:matched intent, matched entities, missing words. This can be present for Dialog interactions but will then only contain information about matched entities.

text (json)

yes

GenerativeAISources

JSON object containing sources used in generating any AI generated answer and if present, the reasoning given for the answer.

text (json)

yes

Translation

If we translated the userinput in order to recognise it, this will say either 'Culture Selected' or 'Culture Detected'. If we did a detection but did not translate, it will say 'No Translation'. If we didn't even attempt a detection, this will be null.

text

yes

TranslationDetails

All the information we used when translating userinput, including the original input, what language we translated from, whether we determined that language via detection, and the confidence of the detection.
If a translation has taken place, the 'originalinput' from this field is what the user actually typed in.

text (json)

yes

Articles

JSON object containing all the information about the articles involved in answering the user question.

text (json)

yes

Onlinecategory

The category (ies) the articles involved in the response are assigned to for the classification that was included in the request

text (json)

yes

FaqsFound

For an FAQSearch or Dataretrieval interaction, the list of FAQs found.

text (json)

yes

Pages

A json object containing the originatingpage and the previouspage for the interaction. Not nullable but the page information may be an empty string

text (json)

no

CustomerProjectIdentifier

an identifier for the project, using CUSTOMERKEY_PROJECTKEY

text

no

PublishInfo

Information about when the knowledgebase that this interaction happened against was published and where.

text (json)

no

SessionDetails

Standard information about the session at the time the interaction took place. This includes ‘sessionisactive’ but unlike the separate column this one is not updated when the session becomes active

text (json)

no

AdditionalSessionInfo

Additional information about the session.  For the moment his includes the useruuid and  any userinfo marked as 'showinReporting'.

text (json)

yes

Variables

(Currently) always-empty field anticipating future use.

text(json)

yes