Overview

The Data API is a product offered by Moveworks that is designed to allow customers to ingest AI Assistant conversations and interaction data through a REST API. The Data API exposes all interactions, including user utterances, button clicks, link clicks, and UI form submissions. It also provides information on the plugins invoked by the LLM, resources used to generate summarized responses, and users who have been ingested into Moveworks and have access to the AI Assistant.

What is a rest API?

A REST API (Representational State Transfer Application Programming Interface) enables systems to communicate over HTTP using a set of architectural principles. It is stateless, meaning each request from a client to the server must contain all necessary information. The key HTTP methods used are GET (retrieve data), POST (create data), PUT (update data), and DELETE (remove data). Resources are accessed via standard URLs, and JSON format is typically used for data exchange. REST APIs are known for their simplicity, scalability, and flexibility, making them ideal for web services and mobile applications.

Learn more about REST API here.

API version

Data API is currently in Beta2 version which is a beta version of the API. To read more on the API lifecycle management please refer to this documentation.

Which REST Endpoints are exposed via Data API

In the beta2 version, The Data API exposes base tables related to AI Assistant conversations data. The following tables are exposed through individual REST endpoint. Only GET method is supported on these endpoints.

API structure

All REST endpoints will respond in JSON format defined by OData. Each JSON object represents a new unique entry in that table

{
"odata.context": "...",
"odata.nextlink": "...",
"value" : [

	{ //object 1

	},
	{ //object 2

	}

	]
	
}

• If there is no entries present in the table, the value array is empty.
• All attributes in each entity either contains a “value” or will be NULL . There will be no empty strings or empty JSON if data is not present for a certain field.
• All attributes are exposed as STRING, nested JSON with STRING key <> value pair and array of STRING. We are not exposing any other data type from the API.

📘

For API documentation refer [here](https://help.moveworks.com/reference/get_conversations).

Data Dictionary

The following tables cover what attributes are available in through individual REST API’s. To understand the exact attribute names for each REST endpoints please refer to the API documentation.

Conversations

Interactions

Fields inside the “detail” JSON object

Plugin calls

Plugin resources

Field included in the “detail” JSON object

Users