Skip to main content
GET
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
Start of the analytics window as a Unix epoch timestamp.
number
required
End of the analytics window as a Unix epoch timestamp.
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.

Response

Returns a partial analytics summary object for the requested section. See Get agent analytics for the field-level analytics schema.

Errors

The path ID, section, or query parameters are invalid. startEpoch and endEpoch are required.
The API key is missing, malformed, revoked, or invalid.
The API key does not include the read scope required for this route.
The agent belongs to a different workspace.
Fini failed while loading analytics.