# OpenAPI Dokumentation

# /api/health

# GET

# Summary

A simple healthcheck endpoint.

# Description

A simple healthcheck endpoint.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
200	The application is up and running

# /api/info

# GET

# Summary

Returns information about configuration and versions

# Description

Returns multiple stats about the application and the running plattform, such as component versions and configurations.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
200	Gives some basic information about the versions of the clusters components.

# /api/v4/dialog/question

# POST

# Summary

Send a question request

# Description

Send a question request to moonkin, which forwards it to the according chatbot backend and returns the mapped answer

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
201	The answered question
400	No valid conversationID specified
500	Marvin threw an internal error

# /api/v4/dialog/analytics

# POST

# Summary

Send an analytics event

# Description

Send an analytics event to moonkin, which will store it in its database

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
default	The logged analytics event

# /api/v4/events

# GET

# Summary

Get events by different filters

# Description

Get events which match the given filters

# Parameters

Name	Located in	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime
conversation	query	No	string
type	query	No	string
sender	query	No	string
sort	query	No	string
reporting	query	No	boolean
textQuery	query	No	string
tokenized	query	No	boolean
tag	query	No	string
omitCount	query	No	boolean
referrers	query	No	[ string ]
showFirstGreeting	query	No	boolean
eventTags	query	No	string

# Responses

Code	Description
200	A list of events

# /api/v4/events/{eventID}

# GET

# Summary

Get event by ID

# Description

Get an event by given eventID

# Parameters

Name	Located in	Description	Required	Schema
eventID	path		Yes	string

# Responses

Code	Description
200	The requested event

# /api/v4/events/filter

# POST

# Summary

Get events by reporting filters

# Description

Get events which match the given reporting filters

# Parameters

Name	Located in	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime
conversation	query	No	string
type	query	No	string
sender	query	No	string
sort	query	No	string
reporting	query	No	boolean
textQuery	query	No	string
tokenized	query	No	boolean
tag	query	No	string
omitCount	query	No	boolean
referrers	query	No	[ string ]
showFirstGreeting	query	No	boolean
eventTags	query	No	string

# Responses

Code	Description
200	The requested events

# /api/v4/events/{eventID}/reporting

# PATCH

# Summary

Update reporting data for a single event

# Description

Update or remove reporting data for a single event with given eventID

# Parameters

Name	Located in	Description	Required	Schema
eventID	path		Yes	string
op	query		Yes	string

# Responses

Code	Description
200	The updated event
400	Missing or invalid parameters
404	Event not found

# /api/v4/events/meta/distinct

# GET

# Summary

Get distinct meta values

# Description

Get all distinct values for a meta-key including the number of occurences

# Parameters

Name	Located in	Description	Required	Schema
meta	query		Yes	string

# Responses

Code	Description
200	An array of meta values

# /api/v4/events/reporting/expectedAnswers

# POST

# Summary

Get events with expected answers

# Description

Get all events with expected answers matching the filter criteria

# Parameters

Name	Located in	Description	Required	Schema
group	header		No	string

# Responses

Code	Description
200	A list of events

# /api/v4/statistics

# GET

# Summary

Get statistics of a chatbot

# Description

Get statistics of a chatbot by given group

# Parameters

Name	Located in	Required	Schema
group	header	No	string
limit	query	Yes	number
since	query	No	dateTime
until	query	No	dateTime
referrers	query	Yes	[ string ]

# Responses

Code	Description
200	The requested statistics
400	Bad request

# /api/v4/statistics/data/{datakey}

# GET

# Summary

Execute a query on events data

# Description

Execute a query on the data fields of events

# Parameters

Name	Located in	Required	Schema
datakey	path	Yes	string
group	header	No	string
op	query	Yes	string
since	query	No	dateTime
until	query	No	dateTime

# Responses

Code	Description
200	The result of the executed query

# /api/v4/statistics/meta/{metaData}

# GET

# Summary

Execute a query on events meta

# Description

Execute a query on the metadata fields of events

# Parameters

Name	Located in	Required	Schema
group	header	No	string
metaData	path	Yes	string
op	query	Yes	string
since	query	No	dateTime
until	query	No	dateTime

# Responses

Code	Description
200	The result of the executed query
400	Operation not found
404	No events with meta data found

# /api/v4/statistics/intentIds

# GET

# Summary

Execute a query on intent ids

# Description

Execute a query on specific event ids

# Parameters

Name	Located in	Required	Schema
group	header	No	string
op	query	Yes	string
since	query	No	dateTime
until	query	No	dateTime

# Responses

Code	Description
200	The result of the query
400	Operation not found
404	No events with intentIds found
500	Missing operation

# /api/v4/statistics/firstGreeting

# GET

# Summary

Count first greeting events

# Description

Count first greeting events and conversations which only contain them

# Parameters

Name	Located in	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime

# Responses

Code	Description
200	The amount of events and conversations
400	Bad request

# /api/v4/conversations

# GET

# Summary

Get all conversations

# Description

Get all conversations related to a specific group or of all chatbots.

# Parameters

Name	Located in	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime
sort	query	No	number
marked	query	No	boolean
referrers	query	No	[ string ]
showFirstGreeting	query	No	string

# Responses

Code	Description
200	A list of conversations
400	Invalid request

# /api/v4/conversations/search

# GET

# Summary

Search in message events

# Description

Search for text in message events and return the matching events

# Parameters

Name	Located in	Required	Schema
textQuery	query	Yes	string
since	query	No	dateTime
until	query	No	dateTime
conversationId	query	Yes	string
limit	query	Yes	number

# Responses

Code	Description
200	A list of events matching the text criteria

# /api/v4/conversations/{conversationID}

# GET

# Summary

Get a conversation

# Description

Get a conversation with given conversationID

# Parameters

Name	Located in	Description	Required	Schema
conversationID	path		Yes	string
raw	query		Yes	boolean

# Responses

Code	Description
200	The requested conversation
400	Invalid request

# /api/v4/conversations/{conversationId}/events/{eventId}

# GET

# Summary

Get an event

# Description

Get a specific event of a conversation

# Parameters

Name	Located in	Description	Required	Schema
conversationId	path		Yes	string
eventId	path		Yes	string

# Responses

Code	Description
200	The specified event of given conversation
400	Message or Conversation not found

# /api/v4/conversations/{conversationID}/reporting

# PATCH

# Summary

Update the reporting data of a conversation

# Description

Update or remove reporting data of a given conversation

# Parameters

Name	Located in	Description	Required	Schema
conversationID	path		Yes	string
op	query		Yes	string

# Responses

Code	Description
200	The updated conversation
400	Missing or invalid parameters
404	Conversation not found

# /api/v4/nlu/engine/check

# GET

# Summary

Checks available engines.

# Description

Checks whether an engine with the desired configuration is available.

# Parameters

Name	Located in	Description	Required	Schema
customer	query	Customer-specific Namespace key	Yes	String
product	query	Specific product key for the customer's namespace	Yes	String
group	query	Specific group key for the chatbot instance within the namespace	Yes	String

# Responses

Code	Description
200	An engine was found!
404	No engine found for the desired configuration!

# /api/v4/nlu/engine/list

# GET

# Summary

Lists all registered NLU Engines

# Description

Lists all registered NLU Engines with their according configuration

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
200	The list of registered engines

# /api/v4/nlu/engine/list/kubernetesdetails

# GET

# Summary

Lists all NLU Engines with their status details.

# Description

Lists all NLU Engines with their status details.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
200	The list of marvin instances and their status.

# /api/v4/nlu/engine/register

# POST

# Summary

# Description

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description
200	The registered engine

# Models

# VersionInformation

Name	Type	Required
apiVersions	[ string ]	Yes
moonkin	string	Yes
editor	string	Yes
mysql	string	Yes
opensearch	string	Yes
opensearchDashboards	string	Yes
redis	string	Yes

# QuestionDTO

Name	Type	Required
conversation	string	No
question	string	Yes
meta	object	No
customer	string	Yes
product	string	Yes
group	string	Yes

# EventSender

Name	Type	Description	Required
type	string		Yes
id	string		Yes

# MessageTextXML

Name	Type	Description	Required
innerXML	string		Yes

# Event

Name	Type	Required
id	string	Yes
date	string	Yes
conversation	string	Yes
customer	string	Yes
data	[ string ]	Yes
group	string	Yes
intentIds	[ string ]	Yes
links	[ string ]	Yes
sender	object	Yes
product	string	Yes
raw	string	Yes
text	string	Yes
textXML	object	Yes
texthash	string	Yes
type	string	Yes
meta	object	Yes
reporting	object	Yes

# Target

Name	Type	Description	Required
id	string		Yes
type	string		Yes

# AnalyticsEventDTO

Name	Type	Required
target	object	No
tags	[ string ]	No
data	object	No
customer	string	Yes
product	string	Yes
group	string	Yes
conversation	string	Yes

# AnalyticsEvent

Name	Type	Required
id	string	Yes
date	string	Yes
conversation	string	Yes
customer	string	Yes
data	[ string ]	Yes
group	string	Yes
intentIds	[ string ]	Yes
links	[ string ]	Yes
sender	object	Yes
product	string	Yes
raw	string	Yes
text	string	Yes
textXML	object	Yes
texthash	string	Yes
type	string	Yes
meta	object	Yes
reporting	object	Yes
target	object	Yes
tags	[ string ]	Yes

# EventsResponse

Name	Type	Required
events	[ string ]	Yes
limit	number	Yes
page	number	Yes
total	number	Yes

# Entry

Name	Type	Description	Required
key	string		Yes
value	string		Yes

# MetaCount

Name	Type	Description	Required
key	string		Yes
doc_count	number		Yes

# ExpectedAnswerFilter

Name	Type	Required
status	string	Yes
deployed	string	Yes
comment	string	Yes
ticketLink	string	Yes
answerId	number	Yes
ticketId	string	Yes

# Questions

Name	Type	Description	Required
Count	number		Yes

# Answers

Name	Type	Description	Required
Count	number		Yes

# Conversations

Name	Type	Description	Required
Count	number		Yes

# Statistic

Name	Type	Required
Questions	object	Yes
Answers	object	Yes
Conversations	object	Yes
TopAnswers	[ string ]	Yes

# MetaDataResponse

Name	Type	Description	Required
Value	string		Yes
Count	number		Yes

# FirstGreetingResponse

Name	Type	Description	Required
events	number		Yes
conversations	number		Yes

# ConversationsResponse

Name	Type	Required
conversations	[ string ]	Yes
limit	number	Yes
page	number	Yes
total	number	Yes

# EventList

Name	Type	Required
count	number	Yes
ids	[ string ]	Yes
raw	[ string ]	Yes

# ConversationResponse

Name	Type	Required
created	string	Yes
events	object	Yes
id	string	Yes
groups	[ string ]	Yes
modified	string	Yes
reporting	object	Yes

# Engine

Name	Type	Required
id	string	Yes
url	string	Yes
product	string	Yes
customer	string	Yes
group	string	Yes
healthiness	number	Yes
version	string	Yes
state	string	Yes

# RegisterEngineDTO

Name	Type	Required
url	string	Yes
product	string	Yes
customer	string	Yes
group	string	Yes
version	string	Yes