Get instant messaging overview statistics

POST

/openapi/reporting/instantmessagesoverview

const url = 'https://open-api.replyco.com/openapi/reporting/instantmessagesoverview';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '{ "timezoneOffset": 1, "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "accountIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "marketplaces": [ "0 - PlaceholderDoNotUse" ], "ignoreBlockedCustomers": true, "ignoreInActiveTickets": true, "useWorkingHours": true, "userIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://open-api.replyco.com/openapi/reporting/instantmessagesoverview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "timezoneOffset": 1, "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "accountIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "marketplaces": [ "0 - PlaceholderDoNotUse" ], "ignoreBlockedCustomers": true, "ignoreInActiveTickets": true, "useWorkingHours": true, "userIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Returns comprehensive overview of live chat/instant messaging activity.

Overview metrics:

Total chats handled
Active chats
Average response time
Resolution rate
Customer satisfaction

Use cases:

Live chat dashboard
Performance overview
Real-time monitoring
KPI tracking

Authorizations

Bearer

Request Body

Instant messages filter with date range and options

object

timezoneOffset

integer format: int32

from

string format: date-time

nullable

string format: date-time

nullable

accountIds

Array<string>

nullable

marketplaces

Array<integer>

nullable

Allowed values: 0 - PlaceholderDoNotUse 1 - Ebay 2 - Etsy 3 - Mail 4 - BigCommerce 5 - WooCommerce 6 - Magento 7 - Shopify 8 - Linnworks 10 - Gmail 11 - Telegram 12 - Widget 13 - Cdiscount 14 - Facebook 15 - Fruugo 16 - AmazonSP 17 - Instagram 18 - Wish 19 - ChannelAdvisor 20 - CustomIntegration 21 - Outlook 22 - Veeqo 23 - Aircall 24 - Katana 25 - Billbee 26 - Kaufland 27 - WhatsApp 28 - ShopLine 29 - Brightpearl 30 - TikTok 31 - Otto 32 - RestApiEbay

ignoreBlockedCustomers

boolean

ignoreInActiveTickets

boolean

useWorkingHours

boolean

userIds

Array<string>

nullable

Responses

200

Returns instant messages overview

400

Invalid filter parameters

401

User is not authenticated or authorized