v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Analytics 3.0

Get Conversation Counter Metrics for the Organization

Gets conversation counter metrics for the organization. Data is available up to one day ago, and only for 2025 onwards.

get/v3.0/conversationcounter

Query parameters

yearnumber required
monthnumber
nonConversationalboolean

Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.

channel'facebook' | 'alexa' | 'slack' | 'generic' | 'inject' | 'rest' | 'realtime' | 'socket' | 'adminconsole' | 'webchat2' | 'dialogflow' | 'twilio' | 'twilio-sms' | 'line' | 'intercom' | 'microsoftBotFramework' | 'microsoftTeams' | 'sunshineConversations' | 'admin-webchat' | 'avaya' | 'nonConversational' | 'voiceGateway2' | 'amazonLex' | 'workplace' | 'webhook' | 'abstractRest' | 'userlike' | 'ringCentralEngage' | 'audioCodes' | 'bandwidth' | 'whatsapp' | 'eightByEight' | 'genesysBotConnector' | 'niceCXOne' | 'agentAssistVoice' | 'webchat3' | 'niceCXOneAAH' | 'zoomContactCenter' | 'mcpServer'
Example:webchat3

As of release 4.96, conversations can be filtered by specific channels like "webchat2". Previously, "webchat2" conversations were aggregated under "realtime" and could not be individually filtered.

Response

The conversation counter stats for the given time-frame.