Get Conversation Counter Metrics for a Project - Cognigy Documentation

Get Conversation Counter Metrics for a Project

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

Try it

Example cURL Request

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter \
  --header 'X-API-Key: <api-key>'

Example Python Code

import requests

url = "https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

Example JavaScript (Fetch API)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Example PHP Code

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Go Code

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/new/v3.0/projects/{projectId}/conversationcounter"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Response Codes

• 200: Successful request, returns conversation counter stats for the specified time-frame.
• 400: Bad Request - Validation failed. Missing payload.
• 401: Unauthorized - Invalid or missing API key.
• 402: Payment Required - An error occurred with billing or payment validation.
• 403: Forbidden - Access to the resource is denied.
• 404: Not Found - The resource could not be found.
• 405: Method Not Allowed - The HTTP method used is not allowed for this endpoint.
• 409: Conflict - The request could not be completed due to a conflict.
• 413: Payload Too Large - The request payload is too large.
• 500: Internal Server Error - An error occurred on the server.
• 501: Not Implemented - The server does not support the functionality required to fulfill the request.
• 502: Bad Gateway - Invalid response from the upstream server.
• 503: Service Unavailable - The server is currently unable to handle the request.
• 504: Gateway Timeout - The upstream server failed to respond in a timely manner.

Response Example

{
  "items": [
    {
      "conversations": 123,
      "day": 123,
      "month": 123,
      "year": 123,
      "perChannel": [
        {
          "channel": "<string>",
          "conversations": 123
        }
      ]
    }
  ]
}

Error Response Example

{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

• API Key: Supply the API Key in the HTTP-Header.