Breadcrumbs

Comparison between ReportingAPI and AnalyticsAPI Columns

ReportingAPI > AnalyticsAPI

ReportingAPI Column

AnalyticAPI equivalent

activatedcontext

Contexts

additional_userinfo

AdditionalSessionInfo

categories

in Articles for all Categories per article, OnlineCategory for the category active online where available

channel

Channel

confidence

(in TranslationDetails)  TranslationDetails.confidence

culture

Culture

detected_culture

(in TranslationDetails) TranslationDetails.translationLanguage

detection_used

(in TranslationDetails) TranslationDetails.detectionUsed

dialogname

(in Articles) Articles.dialog[n].dialogName

dialognodetype

(in Articles) Articles.dialog[n].nodeType

eventkbaname

(in Articles) Articles.event[n].eventName

feedbackcomment

(in FeedbackInfo) FeedbackInfo.comment

feedbacklabel

(In FeedbackInfo) FeedbackInfo.label

feedbackoptionshown

n/a

feedbackoriginatinginteractionid

OriginatingInteractionUuid (or FeedbackInfo.originatingInteractionId)

feedbackscore

(In FeedbackInfo) FeedbackInfo.score

generativeaisources

GenerativeAISources

interactiontype

MainInteractionType/AllInteractionTypes

interactionuuid

InteractionUuid

interactionvalue

InteractionValue

kbaid

ArticleIds

linkclickoriginatinginteractionid

OriginatingInteractionUuid (or LinkclickInfo.originatingInteractionId)

linkclickurl

(in LinkclickInfo) LinkclickInfo.url

linkedkbaid

in Articles/ ArticleIds

linksavailable

Not present in AnalyticsAPI. The number of links available can be determined from the number of href mentions in the outputtext

logid

LogId

messagecontent

Not present in AnalyticsAPI. The messagecontent can be determined by checking for the presence of href ( 'text + link(s)') or dialogoptions  ('text + dialogoptions') in the outputtext  -- if there are none, but there is an outputtext, it's 'text only' and otherwise it's 'empty'

modeid

(in SessionDetails) SessionDetails.mode  (text identifier instead of numerical ID)

originalsessionuuid

(in SessionDetails) SessionDetails.originalSessionUuid

originatingpage

(in Pages) Pages.originatingPage

outputmetadata

OutputMetaData

outputtext

OutputText

previouspage

(in Pages) Pages.previousPage

previoussessionuuid

(in SessionDetails) SessionDetails.previousSessionUuid

projectid

 ~ CustomerProjectIdentifier  (text identifier instead of numerical ID)

recognitionrate

RecognitionQuality

resultlist

FaqsFound

sessionactivity

SessionIsActive

sessionuuid

SessionUuid

timestamputc

TimestampStart  (TimestampEnd is the time at which the interaction was fully finished. TimestampStart  has always been the basis for timestamputc

untranslated_input

(in TranslationDetails) TranslationDetails.originalInput

useridentifier

(in AdditionalSessionInfo - where available)

useruuid

(in AdditionalSessionInfo) AdditionalSessionInfo.userUuid


AnalyticsAPI > ReportingAPI

See also Interaction Logs from the Analytics API for general column descriptions.

AnalyticsAPI Column

ReportingAPI Equivalent

AdditionalSessionInfo

useruuid, userinfo

AllInteractionTypes

In the ReportingAPI every interactiontype involved in an interaction had its own logging row. In the new logs, there is 1 row per interaction; all the interactiontypes involved are reported in the  AllInteractiontypes column.

ArticleIds

kbaid

Articles

A JSON column with information about all articles involved in generating the AI Cloud answer. This includes information from the DialogName, DialogNodename, EvenName and Categories columns from the ReportingAPI as wel as LinkedKbaid

Channel

Channel

Contexts

ActivatedContexts

Culture

Culture

CustomerProjectIdentifier

ProjectID (The new field is a string instead of a number, but this identifies the project the interaction was for)

DialogPaths

New column: This contains a JSON object with the paths taken through a just-started Dialog (Started), one that was in progress or just ended (EndedOrInProgress), or the dialog that was active/activated in the previous interaction but not used to answer the current question (DropOut). The format of a dialogpath is <dialogid>:<nodeid>/<nodeid>! Where everything after <dialogid>:<nodeid> is optional and an exclamation mark at the end indicates that the Dialog is ended (showing an answer with no further option to continue within the Dialog) at that point.

FaqsFound

resultlist

FeedbackInfo

a JSON column with all the information for a feedback interaction. Corresponds to the ReportingAPI feedbackoriginatinginteractionuuid, feedbackscore, feedbacklabel and feedbackcomment columns.

GenerativeAISources

generativeaisources

InteractionUuid

interactionuuid

InteractionValue

interactionvalue

LinkclickInfo

A JSON column with the information for a linkclick interaction. Corresponds to the ReportingAPI linkclickoriginatinginteractionuuid and linkclickurl columns

LogId

logid

MainInteractionType

New column: the main important interactiontype for recognition. Usually the one starting the interaction

OnlineCategory

New Column: categories that were active online, if known.

OriginatingInteractionUuid

Feedbackoriginatinginteractionuuid/Linkclickoriginatinginteractionuuid 

OutputMetadata

outputmetadata

OutputText

outputtext

Pages

JSON containing the information from the ReportingAPI columns originatingpage and previouspage

PublishInfo

New Column: information about when this version of the content was published and whether that was on the Production or Staging environment

RecognitionDetails

New Column: JSON object with all information about how we recognised a QA question and which entities were found when using Dialog recognition.

RecognitionQuality

recognitionquality

RecognitionType

New Column: At what level (hybrid NLU) level did we recognise a QA question 

SessionDetails

General information about the session. This includes the previousSessionuuid and the originalSessionUuid to link sessions together after expiring

SessionIsActive

sessionactivity

SessionUuid

sessionuuid

TDialogStatus

New column: which slots in a T-Dialog are or are not completed.

TimestampEnd

New column: timestamp (in UTC) at which the interaction finished (== the answer was sent to the user)

TimestampStart

timestamputc

Translation

New column: indicates whether a translation took place, and whether it was on the basis of Detection or because the user Selected a certain language.

TranslationDetails

JSON containing all information about detections and translations. Includes the ReportingAPI columns confidence, detection_used, detected_culture and untranslated_input

Variables

New Column, currently always empty anticipating future use.