Data export
Overview
The Data Export API provides authenticated access to your AI Agent’s conversation and message data. You can then export this information to your data warehouse for your own intelligence tool to ingest.
This feature may not be included with your organization’s subscription package. For more information, see Ada’s Pricing page, or contact your Ada team.
Limitations
To ensure a smooth experience and minimize the potential for any downtime, be aware of the following constraints.
Data ingestion time
It takes at least two hours to ingest conversation data into the Data API database. This means that queries won’t return data from conversations created within the previous two hours.
There are occasional delays when ingesting conversation data; if you did not receive the data you are expecting, please contact your Ada team.
Refer to the data export overview in the developer documentation for complete details about setting up requests to the Data Export API.
Rate limit
The Data Export API is subject to a rate limit of 10 requests/second per endpoint. If you exceed the rate limit, you may receive a 429 Too Many Requests response status code. Rate limits ensure infrastructure stability for all clients.
Page size and date range limitations
In addition to rate limits, the API enforces page size and date range limitations.
-
Maximum 10,000 records per page
-
Exports are limited to records from the previous year
Use cases
Export conversation data to support the following scenarios:
- Analytics: Perform data analysis in your own business intelligence tool.
- Compliance: Save conversations permanently in your own system.
- Accessibility: Easily retrieve conversation data when requested by the end user.
Capabilities & configuration
The Data Export API is built according to REST principles. Request bodies should be composed using JSON.
The API has two endpoints:
- Conversations: Export information about conversations.
- Messages: Export information about individual messages.
Each endpoint responds with either a Conversation or a Message object containing the requested data.
Quick start
Export conversation data to your data warehouse in a few steps.
Generate an Ada API key from the Ada dashboard.
Use the Conversations endpoint to export conversation-level data, or the Messages endpoint for message-level data.
For detailed instructions on authentication and API usage, see Implementation & usage.
Implementation & usage
Configure API keys and make requests to the Data Export API.
Work with Ada API keys
To keep your data safe, all requests to the Data Export API must be authenticated. Requests to Ada’s APIs are authenticated using an API key. An API key is like a password, but API keys are a lot more complex than a typical human password, which makes them a lot more secure.
You can use an existing API key that someone in your organization generated for your AI Agent, if it was either specifically generated for the Data Export API, or if it’s a newer, general key that works for all of Ada’s APIs:
-
If a key was generated for a specific API, that key will still only work for that API. The names for API-specific keys indicate which APIs they’re associated with, followed by “(Legacy)”.
-
If a key was generated for all of Ada’s APIs, you can use that key again, or you can create a new one by following the steps below. Your AI Agent can have multiple active general API keys; creating a new one doesn’t invalidate any existing keys.
Regardless of which type of key you have, they don’t expire, and provide read and write access to all Ada APIs available to your organization.
Generate an Ada API key
You can generate a new Ada API key from the Ada dashboard, which works for all APIs your organization has access to.
To generate an Ada API key:
-
On the Ada dashboard, go to Config > PLATFORM > API keys. The API keys page opens.
-
Create a new API key:
- If your AI Agent doesn’t have any API keys, click Get started.
- If your AI Agent has existing API keys, click New API key.
The New API key window opens.
-
In the New API key window, enter a Name for the key, then click Generate key.
You won’t be able to change the key’s name in the future.
-
Click Copy to copy your API key, then save it in a secure place immediately.
For security reasons, the Ada dashboard only displays your API key once. If you lose this key, you’ll need to create a new one.
-
Click Done to close the New API Key window and protect your new API key.
Use your Ada API key
Place your Ada API key in the value field of the Bearer authentication header in your HTTP request tool, as indicated:
Use the Data Export API
For a detailed guide to creating Data Export API requests, see the developer documentation.
Related features
- Conversation identifiers and persistence: Understand how conversation and user identifiers work in exported data.
- Data retention: Learn how long conversation data is stored before deletion.
- Authentication: Manage API keys for authenticating requests.