Skip to main content
GET
/
v2.0
/
conversationcounter
Get Conversation Counter Metrics for the Organization
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/conversationcounter \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "conversations": 123,
      "day": 123,
      "month": 123,
      "year": 123,
      "channel": "<string>"
    }
  ]
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Query Parameters

ā€‹
year
number
required
ā€‹
month
number
ā€‹
nonConversational
boolean

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

ā€‹
channel
enum<string>

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.

Available options:
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"

Response

The conversation counter stats for the given time-frame.

ā€‹
items
object[]