# OpenAPI Dokumentation

Übergangslösung

Für eigene Entwicklungen ist die Partner-API die empfohlene Schnittstelle. Diese Seite dokumentiert nur noch Funktionen, die dort noch nicht zur Verfügung stehen – im Wesentlichen Abfragen für Auswertung und Reporting. Sie wird schrittweise abgebaut, sobald die entsprechenden Funktionen in der Partner-API verfügbar sind.

Es handelt sich um einen Ausschnitt der internen Plattform-API (Kauz Moonkin Private API). Antworten zu generieren und Analytics-Events zu melden ist bereits vollständig über die Partner-API möglich und dort dokumentiert:

Antworten generieren

../partner-api-antworten-generieren/

Analytics-Events

../analytics-events/

# /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/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
sortOrder	query	No	string
reporting	query	No	boolean
textQuery	query	No	string
tokenized	query	No	boolean
tag	query	No	string
omitCount	query	No	boolean
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean

# 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
sortOrder	query	No	string
reporting	query	No	boolean
textQuery	query	No	string
tokenized	query	No	boolean
tag	query	No	string
omitCount	query	No	boolean
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean

# 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	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean
key	query	Yes	string

# Responses

Code	Description
200	An array of meta values

# /api/v4/events/reporting/distinct

# GET

# Summary

Get distinct meta values

# Description

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

# Parameters

Name	Located in	Required	Schema
group	header	No	string
since	query	No	dateTime
until	query	No	dateTime
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean
key	query	Yes	string

# Responses

Code	Description
200	An array of meta values

# /api/v4/statistics

# GET

# Summary

Get statistics of a chatbot

# Description

Get statistics of a chatbot by given group

# Parameters

Name	Located in	Description	Required	Schema
group	header		No	string
limit	query		Yes	number
since	query		No	dateTime
until	query		No	dateTime
excludedReferrers	query		No	[ string ]
showFirstGreeting	query	The chat widget sends a `CR:firstGreeting` request at the start of every conversation, so by default it is excluded from all four figures: for `Conversations.Count`, conversations with 2 or fewer events are excluded (assumed to be just this request and the bot's reply); for `Questions.Count`, the request itself is excluded; for `Answers.Count` and `TopAnswers`, the bot's canned reply to it is excluded. Since the request occurs once per conversation regardless of how the conversation continues, `Questions.Count`/`Answers.Count` typically change by roughly the total number of conversations when this is toggled, not just by the number of conversations that consist of only the greeting. Set to `true` to include it everywhere.	No	boolean

# 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/sender/{senderkey}

# GET

# Summary

Execute a query on events sender

# Description

Execute a query on the sender fields of events

# Parameters

Name	Located in	Required	Schema
senderkey	path	Yes	string
group	header	No	string
op	query	Yes	string
since	query	No	dateTime
until	query	No	dateTime
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean

# 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	string
marked	query	No	boolean
excludedReferrers	query	No	[ string ]
showFirstGreeting	query	No	boolean

# 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

# Models

# VersionInformation

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

# EventSender

Name	Type	Required
type	string	Yes
id	string	No
phoneNumber	string	No

# MessageTextXML

Name	Type	Description	Required
innerXML	string		Yes

# Event

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

# Target

Name	Type	Description	Required
id	string		Yes
type	string		Yes

# AnalyticsEvent

Name	Type	Required
id	string	Yes
date	string	Yes
conversation	string	Yes
customer	string	No
data	[ string ]	No
group	string	No
instanceGroup	string	No
intentIds	[ string ]	No
links	[ string ]	No
sender	object	Yes
product	string	No
raw	string	No
text	string	No
textXML	object	No
texthash	string	No
type	string	Yes
meta	object	No
reporting	object	No
content	object	No
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

# 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
meta	object	Yes