Get project conversation analytics

Retrieve voice conversation analytics for a project

GET /organizations/{organization_id}/projects/{project_id}/conversation-analytics

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/conversation-analytics" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode 'filters={"status":"completed","start_time":{"$gte":"2026-07-01T00:00:00Z","$lte":"2026-07-22T23:59:59Z"}}'

const params = new URLSearchParams({
  filters: JSON.stringify({
    status: "completed",
    start_time: {
      $gte: "2026-07-01T00:00:00Z",
      $lte: "2026-07-22T23:59:59Z",
    },
  }),
});

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/conversation-analytics?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import json
import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/conversation-analytics",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "filters": json.dumps(
            {
                "status": "completed",
                "start_time": {
                    "$gte": "2026-07-01T00:00:00Z",
                    "$lte": "2026-07-22T23:59:59Z",
                },
            }
        )
    },
)

200

{
  "status": "success",
  "message": "Conversation analytics retrieved successfully",
  "data": {
    "summary": {
      "total_conversations": 64,
      "completed_conversations": 41,
      "live_conversations": 1,
      "total_duration": 8120.25,
      "avg_duration": 126.88
    },
    "daily_conversations": {
      "2026-07-01": 5,
      "2026-07-02": 9
    },
    "daily_durations": {
      "2026-07-01": 640.0,
      "2026-07-02": 1102.5
    }
  },
  "status_code": 200
}

{
  "status": "error",
  "message": "Project not found",
  "data": null,
  "status_code": 404
}

Returns project-level voice conversation analytics: totals, average duration, and daily conversation/duration maps.

Non-voice projects may return empty metrics.

Authentication

X-API-Key · string · required

Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id · string · required

Organization ID. Must match the API key.

project_id · string · required

Project ID. Must match the API key.

Query parameters

filters · string

JSON MongoDB-compatible filter object. Example: {"status":"completed","start_time":{"$gte":"2026-07-01T00:00:00Z","$lte":"2026-07-22T23:59:59Z"}}.

skip · integer · default: "0"

Accepted for compatibility. Aggregation returns summary series (not a paged conversation list).

limit · integer · default: "20"

Accepted for compatibility (1–1000). Not applied to the summary aggregation.

sort · string

Accepted for compatibility. Not applied to the summary aggregation.

Response

summary · object · required

Aggregate totals for the filtered conversations.

Show properties

total_conversations · integer · required

Total conversations matched.

completed_conversations · integer · required

Conversations with status completed.

live_conversations · integer · required

Conversations with status live.

total_duration · number · required

Sum of duration_seconds.

avg_duration · number · required

Average duration in seconds.

daily_conversations · object · required

Map of date bucket key → conversation count.

daily_durations · object · required

Map of date bucket key → total duration seconds.

Errors

400 · Bad Request

Invalid organization or project id.

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

404 · Not Found

Project not found.

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/conversation-analytics" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode 'filters={"status":"completed","start_time":{"$gte":"2026-07-01T00:00:00Z","$lte":"2026-07-22T23:59:59Z"}}'

const params = new URLSearchParams({
  filters: JSON.stringify({
    status: "completed",
    start_time: {
      $gte: "2026-07-01T00:00:00Z",
      $lte: "2026-07-22T23:59:59Z",
    },
  }),
});

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/conversation-analytics?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import json
import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/conversation-analytics",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "filters": json.dumps(
            {
                "status": "completed",
                "start_time": {
                    "$gte": "2026-07-01T00:00:00Z",
                    "$lte": "2026-07-22T23:59:59Z",
                },
            }
        )
    },
)

200

{
  "status": "success",
  "message": "Conversation analytics retrieved successfully",
  "data": {
    "summary": {
      "total_conversations": 64,
      "completed_conversations": 41,
      "live_conversations": 1,
      "total_duration": 8120.25,
      "avg_duration": 126.88
    },
    "daily_conversations": {
      "2026-07-01": 5,
      "2026-07-02": 9
    },
    "daily_durations": {
      "2026-07-01": 640.0,
      "2026-07-02": 1102.5
    }
  },
  "status_code": 200
}

{
  "status": "error",
  "message": "Project not found",
  "data": null,
  "status_code": 404
}