API Documentation
Get Conversations
Guide for getting conversations from a agent.
Get Conversations API
The Get Conversations API endpoint allows you to retrieve conversations from a specific agent. You can filter conversations based on various criteria, including the agent's ID, date range, and filtered sources.
Endpoint
GET:https://www.chatzuri.com/api/v1/get-conversationsRequest Headers
The API request must include the following headers.
- Authorization:Bearer <Your-Secret-Key>- The secret key for authenticating the API request.
- Content-Type:application/json- The content type of the request payload.
Request Parameters
The request should include the following query parameters:
Required Parameters
- agentId- (string) The ID of the target agent from which you want to retrieve conversations.
Optional Parameters
- filteredSources- (string) Comma-separated sources to filter:"API""Chatzuri site""Instagram""Messenger""Slack""Unspecified""WhatsApp""Widget or Iframe"
- startDate- (string) Start date in 'YYYY-MM-DD' format for filtering conversations.
- endDate- (string) End date in 'YYYY-MM-DD' format for filtering conversations.
- page- (string, default=1) Page number for pagination.
- size- (string, default=10, max=100) Number of results per page.
Example Request
const options = {method: 'GET', headers: {accept: 'application/json'}};
fetch('https://www.chatzuri.com/api/v1/get-conversations?agentId=<agent-id>&startDate=2023-01-01&endDate=2023-12-12&page=1&size=20', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));Response
The API response will be a JSON object with the following structure:
{
"data": [
{
"id": "string",
"created_at": "string",
"messages": [
{
"role": "string",
"content": "string"
}
],
"chatbot_id": "string",
"customer": "string",
"source": "string"
}
]
}The Get Conversations API endpoint provides a way to retrieve conversations from a agent based on specified filters. The response includes an array of conversations, each with its relevant details.
Successfully returns the conversations
If the start/end dates provided are invalid
If the API request is unauthorized
If the agentId provided is invalid
If there is an internal server error
