Get agent analytics section

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?startEpoch=1784073600000&endEpoch=1784678400000&source=all' \
  --header 'Authorization: Bearer fini_your_api_key'

import requests

response = requests.get(
    "https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    params={
        "startEpoch": 1784073600000,
        "endEpoch": 1784678400000,
        "source": "all",
    },
)
section = response.json()

const params = new URLSearchParams({
  startEpoch: "1784073600000",
  endEpoch: "1784678400000",
  source: "all",
});

const response = await fetch(
  `https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?${params.toString()}`,
  {
    headers: {
      Authorization: "Bearer fini_your_api_key",
    },
  }
);
const section = await response.json();

{
  "summary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "comparisonSummary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "summaryCards": {
    "conversationVolume": {
      "currentValue": 100,
      "comparisonValue": 100,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "aiResolutionRate": {
      "currentValue": 70,
      "comparisonValue": 70,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "humanEscalationRate": {
      "currentValue": 20,
      "comparisonValue": 20,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageResponseTime": {
      "currentValue": 2400,
      "comparisonValue": 2400,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "medianResponseTime": {
      "currentValue": 1800,
      "comparisonValue": 1800,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageCsatRating": {
      "currentValue": 80,
      "comparisonValue": 80,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    }
  }
}

GET

bots

{id}

hc-analytics

{section}

public

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?startEpoch=1784073600000&endEpoch=1784678400000&source=all' \
  --header 'Authorization: Bearer fini_your_api_key'

import requests

response = requests.get(
    "https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    params={
        "startEpoch": 1784073600000,
        "endEpoch": 1784678400000,
        "source": "all",
    },
)
section = response.json()

const params = new URLSearchParams({
  startEpoch: "1784073600000",
  endEpoch: "1784678400000",
  source: "all",
});

const response = await fetch(
  `https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?${params.toString()}`,
  {
    headers: {
      Authorization: "Bearer fini_your_api_key",
    },
  }
);
const section = await response.json();

{
  "summary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "comparisonSummary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "summaryCards": {
    "conversationVolume": {
      "currentValue": 100,
      "comparisonValue": 100,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "aiResolutionRate": {
      "currentValue": 70,
      "comparisonValue": 70,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "humanEscalationRate": {
      "currentValue": 20,
      "comparisonValue": 20,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageResponseTime": {
      "currentValue": 2400,
      "comparisonValue": 2400,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "medianResponseTime": {
      "currentValue": 1800,
      "comparisonValue": 1800,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageCsatRating": {
      "currentValue": 80,
      "comparisonValue": 80,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    }
  }
}

Returns one section of the analytics summary for one agent. The accepted section values are summary, trends, knowledge, rules, and escalations. Use this route when you only need part of the analytics payload. Use Get agent analytics when you need the full summary object. For the analytics endpoint family, see Analytics.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

Path parameters

string

required

Agent ID whose analytics you want to read. Use List agents to get the botId.

string

required

Analytics section to return. Accepted values are summary, trends, knowledge, rules, and escalations.

Query parameters

number

required

Inclusive start of the analytics window as a Unix epoch timestamp in milliseconds.

number

required

Exclusive end of the analytics window as a Unix epoch timestamp in milliseconds.

string | string[]

Conversation source filter. Pass all to include all supported sources, or pass one or more source values accepted by Fini.

string | string[]

Optional channel filter.

string | string[]

Optional latest-status filter.

string | string[]

Optional latest-sentiment filter.

string | string[]

Optional knowledge subfolder IDs to filter by.

string | string[]

Optional tag IDs to filter by.

string | string[]

Optional rule IDs to filter by.

string | string[]

Optional escalation-reason tag IDs to filter by.

number | number[]

Optional CSAT ratings to filter by. Values must be integers from 1 through 5.

string

Optional timezone used for date grouping. Defaults to UTC. Defaults to UTC.

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?startEpoch=1784073600000&endEpoch=1784678400000&source=all' \
  --header 'Authorization: Bearer fini_your_api_key'

import requests

response = requests.get(
    "https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    params={
        "startEpoch": 1784073600000,
        "endEpoch": 1784678400000,
        "source": "all",
    },
)
section = response.json()

const params = new URLSearchParams({
  startEpoch: "1784073600000",
  endEpoch: "1784678400000",
  source: "all",
});

const response = await fetch(
  `https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-analytics/summary/public?${params.toString()}`,
  {
    headers: {
      Authorization: "Bearer fini_your_api_key",
    },
  }
);
const section = await response.json();

{
  "summary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "comparisonSummary": {
    "totalConversations": 100,
    "resolvedConversations": 70,
    "escalatedConversations": 20,
    "waitingForCustomerConversations": 10,
    "aiResolutionRate": 70,
    "humanEscalationRate": 20,
    "averageResponseTimeMs": 2400,
    "medianResponseTimeMs": 1800,
    "averageCsatRating": 4
  },
  "summaryCards": {
    "conversationVolume": {
      "currentValue": 100,
      "comparisonValue": 100,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "aiResolutionRate": {
      "currentValue": 70,
      "comparisonValue": 70,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "humanEscalationRate": {
      "currentValue": 20,
      "comparisonValue": 20,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageResponseTime": {
      "currentValue": 2400,
      "comparisonValue": 2400,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "medianResponseTime": {
      "currentValue": 1800,
      "comparisonValue": 1800,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    },
    "averageCsatRating": {
      "currentValue": 80,
      "comparisonValue": 80,
      "absoluteChange": 0,
      "percentChange": 0,
      "changeDirection": "neutral",
      "performance": "neutral",
      "isAvailable": true
    }
  }
}

Response

Returns a partial analytics summary object for the requested section. The example above is a synthetic summary response, matching the request examples.

Section	Included fields
`summary`	`summary`, `comparisonSummary`, and `summaryCards`, including both average and median response times.
`trends`	`usageByChannel`, `statusBreakdown`, conversation-volume, resolution-rate, response-time, hourly-volume, and CSAT chart data. Daily response-time entries include both `averageResponseTimeMs` and `medianResponseTimeMs`.
`knowledge`	Knowledge usage data.
`rules`	Rule analytics data.
`escalations`	Escalation-reason data.

See Get agent analytics for the field-level analytics schema.

Errors

400 Bad Request

The path ID, section, or query parameters are invalid. startEpoch and endEpoch are required.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the read scope required for this route.

404 Not Found

The agent was not found in the authenticated workspace.

406 Not Acceptable

The authenticated request has no workspace context.

500 Internal Server Error

Fini failed while loading analytics.

API Setup

LLM Access

Agents

Analytics

Help Centers

Profile

Macros

Prompts

Actions

Attributes

External API calls

Intent Rules

Guardrails

Business Rules

Reply Rules

Tag groups

Tags

Conversations

Refine with AI

Replays

Test Suite

Knowledge

Updates

Get agent analytics section

Headers

Path parameters

Query parameters

Response

Errors

​Headers

​Path parameters

​Query parameters

​Response

​Errors

Headers

Path parameters

Query parameters

Response

Errors