Analytics

Analytics endpoints are read-only and scoped to your organization.

Authentication & scope

Header: X-API-Key: YOUR_API_KEY
Required scope: analytics:read
Use API Reference for interactive Try-it across all analytics endpoints.

Every analytics endpoint below takes the same four query params:

Parameter	Type	Required	Description
`startDate`	string (ISO date)	no	Only include calls on or after this date.
`endDate`	string (ISO date)	no	Only include calls on or before this date.
`page`	integer (min `1`)	no	Page number, defaults to `1`.
`pageSize`	integer (`1`–`100`)	no	Results per page, defaults to `10`.

`GET /v1/analytics/dashboard`

Returns a small set of top-line numbers for a dashboard view: call volume, average cost and duration per call, team size, and the most common tag and access point.

curl -X GET "https://api.indigenius.ai/v1/analytics/dashboard?startDate=2026-06-01&endDate=2026-06-30&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-06-01',
  endDate: '2026-06-30',
  page: '1',
  pageSize: '10',
});

const response = await fetch(
  `https://api.indigenius.ai/v1/analytics/dashboard?${params}`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.indigenius.ai/v1/analytics/dashboard",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={
        "startDate": "2026-06-01",
        "endDate": "2026-06-30",
        "page": 1,
        "pageSize": 10,
    },
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Dashboard statistics retrieved successfully",
  "data": {
    "totalCallSessions": 124,
    "customerSatisfactionScore": 0,
    "avgResolutionTime": 96,
    "costPerCall": 4,
    "teamMembers": 6,
    "topTags": "sales",
    "topAccessPoint": "phone"
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Field	Type	Description
`totalCallSessions`	number	Total calls in the date range.
`customerSatisfactionScore`	number	Not currently computed — always `0`.
`avgResolutionTime`	number	Average billed call duration in seconds, rounded to the nearest whole second.
`costPerCall`	number	Average billed cost per call, rounded to the nearest whole unit — not fractional.
`teamMembers`	number	Active members on the organization.
`topTags`	string	Most frequent call tag in the range, or `"No tags available"`.
`topAccessPoint`	string	Most common call channel (`phone`, `web`, `widget`) in the range, or `"No access points available"`.

Common status codes

200 success
400 invalid query values
403 missing analytics:read scope
500 server error

`GET /v1/analytics/calls`

Returns call volume by direction, plus a paginated list of individual calls with per-call detail (agent, duration, tag, country).

curl -X GET "https://api.indigenius.ai/v1/analytics/calls?startDate=2026-06-01&endDate=2026-06-30&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-06-01',
  endDate: '2026-06-30',
  page: '1',
  pageSize: '10',
});

const response = await fetch(
  `https://api.indigenius.ai/v1/analytics/calls?${params}`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.indigenius.ai/v1/analytics/calls",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={
        "startDate": "2026-06-01",
        "endDate": "2026-06-30",
        "page": 1,
        "pageSize": 10,
    },
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Call analytics retrieved successfully",
  "data": {
    "totalCalls": 124,
    "inboundCount": 51,
    "outboundCount": 73,
    "callLogs": {
      "currentPage": 1,
      "totalPages": 13,
      "hasNextPage": true,
      "hasPrevPage": false,
      "nextPage": 2,
      "prevPage": 1,
      "record": [
        {
          "id": "665e4a34c65bb95f2f2d72e1",
          "phoneNumber": "+14155552671",
          "time": "2026-06-02T10:00:00.000Z",
          "status": 1,
          "timeZone": "GMT+1",
          "agent": "Sales Agent",
          "callMode": "outbound",
          "callType": "phone",
          "country": "US",
          "duration": 142,
          "tag": "sales"
        }
      ]
    }
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

callLogs is paginated by this endpoint’s own page/pageSize query params (not a separate pagination scheme). timeZone is currently hardcoded to "GMT+1" regardless of the call’s actual timezone.

Common status codes

200 success
400 invalid query values
403 missing analytics:read scope
500 server error

`GET /v1/analytics/satisfaction`

Intended to return satisfaction and sentiment metrics for organization calls.

This endpoint is a partial implementation: positiveFeedback and negativeFeedback are always 0, and satisfactionData.record is always an empty array. neutralFeedback is the only real number returned — a count of calls that have a completed analysis. Don’t build a satisfaction UI on this endpoint yet.

curl -X GET "https://api.indigenius.ai/v1/analytics/satisfaction?startDate=2026-06-01&endDate=2026-06-30&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-06-01',
  endDate: '2026-06-30',
  page: '1',
  pageSize: '10',
});

const response = await fetch(
  `https://api.indigenius.ai/v1/analytics/satisfaction?${params}`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.indigenius.ai/v1/analytics/satisfaction",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={
        "startDate": "2026-06-01",
        "endDate": "2026-06-30",
        "page": 1,
        "pageSize": 10,
    },
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Customer satisfaction analytics retrieved successfully",
  "data": {
    "positiveFeedback": 0,
    "negativeFeedback": 0,
    "neutralFeedback": 34,
    "satisfactionData": {
      "currentPage": 1,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPrevPage": false,
      "nextPage": 1,
      "prevPage": 1,
      "record": []
    }
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
400 invalid query values
403 missing analytics:read scope
500 server error

`GET /v1/analytics/tags`

Returns the distribution of call tags in the date range, most-mentioned first, with a paginated per-tag breakdown.

curl -X GET "https://api.indigenius.ai/v1/analytics/tags?startDate=2026-06-01&endDate=2026-06-30&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-06-01',
  endDate: '2026-06-30',
  page: '1',
  pageSize: '10',
});

const response = await fetch(
  `https://api.indigenius.ai/v1/analytics/tags?${params}`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.indigenius.ai/v1/analytics/tags",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={
        "startDate": "2026-06-01",
        "endDate": "2026-06-30",
        "page": 1,
        "pageSize": 10,
    },
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Tags analytics retrieved successfully",
  "data": {
    "totalTags": 2,
    "topTag": "sales",
    "bottomTag": "support",
    "tagsData": {
      "currentPage": 1,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPrevPage": false,
      "nextPage": 1,
      "prevPage": 1,
      "record": [
        {
          "tagName": "sales",
          "agent": "Unknown",
          "channels": "",
          "mentions": 41
        },
        {
          "tagName": "support",
          "agent": "Unknown",
          "channels": "",
          "mentions": 23
        }
      ]
    }
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

agent and channels on each record are not currently populated (always "Unknown" and "").

Common status codes

200 success
400 invalid query values
403 missing analytics:read scope
500 server error

`GET /v1/analytics/access-points`

Returns call volume grouped by channel (phone, web, widget) and direction, most-used inbound and outbound channel first.

curl -X GET "https://api.indigenius.ai/v1/analytics/access-points?startDate=2026-06-01&endDate=2026-06-30&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-06-01',
  endDate: '2026-06-30',
  page: '1',
  pageSize: '10',
});

const response = await fetch(
  `https://api.indigenius.ai/v1/analytics/access-points?${params}`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests

response = requests.get(
    "https://api.indigenius.ai/v1/analytics/access-points",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={
        "startDate": "2026-06-01",
        "endDate": "2026-06-30",
        "page": 1,
        "pageSize": 10,
    },
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Access point analytics retrieved successfully",
  "data": {
    "accessCount": 2,
    "topInbound": "widget",
    "topOutbound": "phone",
    "accessData": {
      "currentPage": 1,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPrevPage": false,
      "nextPage": 1,
      "prevPage": 1,
      "record": [
        {
          "channel": "widget",
          "callType": "inbound",
          "duration": "N/A",
          "sessions": 55
        },
        {
          "channel": "phone",
          "callType": "outbound",
          "duration": "N/A",
          "sessions": 69
        }
      ]
    }
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

duration on each record is not currently computed — always "N/A".

Common status codes

200 success
400 invalid query values
403 missing analytics:read scope
500 server error

Getting Started

Core APIs

Platform APIs

Analytics

Analytics

Authentication & scope

`GET /v1/analytics/dashboard`

`200 OK`

Common status codes

`GET /v1/analytics/calls`

`200 OK`

Common status codes

`GET /v1/analytics/satisfaction`

`200 OK`

Common status codes

`GET /v1/analytics/tags`

`200 OK`

Common status codes

`GET /v1/analytics/access-points`

`200 OK`

Common status codes

​Analytics

​Authentication & scope

​GET /v1/analytics/dashboard

​200 OK

​Common status codes

​GET /v1/analytics/calls

​200 OK

​Common status codes

​GET /v1/analytics/satisfaction

​200 OK

​Common status codes

​GET /v1/analytics/tags

​200 OK

​Common status codes

​GET /v1/analytics/access-points

​200 OK

​Common status codes

Analytics

Authentication & scope

`GET /v1/analytics/dashboard`

`200 OK`

Common status codes

`GET /v1/analytics/calls`

`200 OK`

Common status codes

`GET /v1/analytics/satisfaction`

`200 OK`

Common status codes

`GET /v1/analytics/tags`

`200 OK`

Common status codes

`GET /v1/analytics/access-points`

`200 OK`

Common status codes