Skip to main content
GET
/
v3.0
/
projects
/
{projectId}
/
conversationcounter
Returns conversation counter metrics.
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "conversations": 123,
      "day": 123,
      "month": 123,
      "year": 123,
      "perChannel": [
        {
          "channel": "<string>",
          "conversations": 123
        }
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
projectId
string
required
Required string length: 24

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
Example:

"webchat3"

Response

The conversation counter stats for the given time-frame.

​
items
object[]
⌘I