Get project analytics

Retrieve chat insight analytics for a project

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

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/analytics" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "start_date=2026-07-01T00:00:00Z" \
  --data-urlencode "end_date=2026-07-22T23:59:59Z"

const params = new URLSearchParams({
  start_date: "2026-07-01T00:00:00Z",
  end_date: "2026-07-22T23:59:59Z",
});

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

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/analytics",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "start_date": "2026-07-01T00:00:00Z",
        "end_date": "2026-07-22T23:59:59Z",
    },
)

200

{
  "status": "success",
  "message": "Project analytics retrieved successfully",
  "data": {
    "tickets": 12,
    "leads": 34,
    "messages": 520,
    "user_engagement": [
      { "label": "Jul 01", "count": 18 },
      { "label": "Jul 02", "count": 22 }
    ],
    "session_growth": [
      { "label": "Jul 01", "count": 3 },
      { "label": "Jul 02", "count": 5 }
    ],
    "lead_generation": [
      { "label": "Jul 01", "count": 3 },
      { "label": "Jul 02", "count": 5 }
    ],
    "group_by": "daily"
  },
  "status_code": 200
}

Returns project-level chat analytics: ticket, lead, and message totals, plus time-series engagement series.

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

start_date · datetime

Include data from this datetime (inclusive).

end_date · datetime

Include data until this datetime (inclusive).

channel_type · string

Filter by channel type (for example web, whatsapp, telegram).

Response

tickets · integer · required

Ticket count in scope.

leads · integer · required

Lead / new customer-profile identity count in scope.

messages · integer · required

Message count in scope.

user_engagement · array · required

Time-bucketed message engagement series (label, count).

session_growth · array · required

Time-bucketed lead / profile growth series (label, count).

lead_generation · array

Same growth series as session_growth (alias for clients).

group_by · string · required

Bucket size used for series: daily, weekly, monthly, or yearly.

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/analytics" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "start_date=2026-07-01T00:00:00Z" \
  --data-urlencode "end_date=2026-07-22T23:59:59Z"

const params = new URLSearchParams({
  start_date: "2026-07-01T00:00:00Z",
  end_date: "2026-07-22T23:59:59Z",
});

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

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/analytics",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "start_date": "2026-07-01T00:00:00Z",
        "end_date": "2026-07-22T23:59:59Z",
    },
)

200

{
  "status": "success",
  "message": "Project analytics retrieved successfully",
  "data": {
    "tickets": 12,
    "leads": 34,
    "messages": 520,
    "user_engagement": [
      { "label": "Jul 01", "count": 18 },
      { "label": "Jul 02", "count": 22 }
    ],
    "session_growth": [
      { "label": "Jul 01", "count": 3 },
      { "label": "Jul 02", "count": 5 }
    ],
    "lead_generation": [
      { "label": "Jul 01", "count": 3 },
      { "label": "Jul 02", "count": 5 }
    ],
    "group_by": "daily"
  },
  "status_code": 200
}