Get conversations report
curl --request GET \
--url https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations \
--header 'Accept: <accept>' \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};
fetch('https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations"
headers = {
"X-Api-Key": "<x-api-key>",
"Accept": "<accept>"
}
response = requests.get(url, headers=headers)
print(response.text){
"conversations_report": [
{
"name": "open_chats_count",
"value": {
"present": 30,
"previous": 20,
"change_percentage": 50
}
},
{
"name": "closed_chats_count",
"value": {
"present": 8,
"previous": 5,
"change_percentage": 60
}
},
{
"name": "new_chats_count",
"value": {
"present": 72,
"previous": 60,
"change_percentage": 20
}
},
{
"name": "replies_sent_count",
"value": {
"present": 75,
"previous": 50,
"change_percentage": 50
}
},
{
"name": "replied_chats_count",
"value": {
"present": 40,
"previous": 32,
"change_percentage": 25
}
},
{
"name": "unassigned_chats_count",
"value": {
"present": 11,
"previous": 8,
"change_percentage": 37.5
}
}
]
}Reports
Get conversations report
Returns conversation volume metrics for the workspace over a date range, each compared against the immediately preceding period of the same length.
GET
/
reports
/
conversations
Get conversations report
curl --request GET \
--url https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations \
--header 'Accept: <accept>' \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};
fetch('https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetochat.com/api/external/v2/reports/conversations"
headers = {
"X-Api-Key": "<x-api-key>",
"Accept": "<accept>"
}
response = requests.get(url, headers=headers)
print(response.text){
"conversations_report": [
{
"name": "open_chats_count",
"value": {
"present": 30,
"previous": 20,
"change_percentage": 50
}
},
{
"name": "closed_chats_count",
"value": {
"present": 8,
"previous": 5,
"change_percentage": 60
}
},
{
"name": "new_chats_count",
"value": {
"present": 72,
"previous": 60,
"change_percentage": 20
}
},
{
"name": "replies_sent_count",
"value": {
"present": 75,
"previous": 50,
"change_percentage": 50
}
},
{
"name": "replied_chats_count",
"value": {
"present": 40,
"previous": 32,
"change_percentage": 25
}
},
{
"name": "unassigned_chats_count",
"value": {
"present": 11,
"previous": 8,
"change_percentage": 37.5
}
}
]
}Replace
Learn how to find your subdomain in Workspace subdomain.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
Pass custom_duration (or omit range_type while passing start_date/end_date) to report on an explicit range instead. When range_type, start_date and end_date are all omitted, the range defaults to all_time.
Available options:
last_7_days, last_30_days, last_24_hours, this_month, last_month, this_year, last_year, this_quarter, last_quarter, this_week, last_week, all_time, custom_duration Example:
"last_7_days"
Response
OK - Request succeeded
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes