COcognigy
Analytics 3.0

Get Conversation Counter Metrics for a Project

Gets conversation counter metrics for a Project by its ID. Data is available up to one day ago, and only for 2025 onwards.

get/v3.0/projects/{projectId}/conversationcounter

Request

Path parameters

projectIdstring required

The unique identifier for the Project.

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.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

The conversation counter stats for the given time-frame.

Changes

No recorded changes to this operation across all 1 revision of this API.