Stats
Ai
What Deskhero answered without a person: auto-reply and chat-bot outcomes, suggested
replies, and the approved FAQ library that drives them.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/stats/ai
- Authorisation
- Minimum role: USER
Request arguments
| Name |
Type |
Source |
| group_ids | Int32[] | Query |
| timeframe | ENUM dashboard_kpi_timeframe | |
| from | DateTime | |
| to | DateTime | |
| compare | Boolean | |
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_stats_ai
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_stats_ai
| Name | Type | ReadOnly | Description |
|---|
| period | DTO_stats_period | | Period |
| auto_answered_pct | DTO_stats_metric | | Share of resolved tickets that never needed a human reply, as a percentage. |
| auto_answered_total | DTO_stats_metric | | Tickets auto-answered in the window. |
| ai_auto_replies | DTO_stats_metric | | AI auto-replies sent in the window (conversation documents, not tickets). |
| static_auto_replies | DTO_stats_metric | | Static (non-AI) auto-replies sent in the window. |
| chat_conversations | DTO_stats_metric | | Tickets that started as a chat-bot conversation. |
| chat_resolved_pct | DTO_stats_metric | | Share of chat conversations the visitor marked as answered, as a percentage. |
| suggested_replies | DTO_stats_metric | | Suggested replies generated in the window. |
| suggested_reply_coverage_pct | Double (nullable) | | Tickets that had a draft waiting, as a share of tickets in the window. |
| success_rate_series | DTO_stats_series[] | | The two AI success rates per bucket, in percent: chat-bot resolved rate and auto-reply
coverage of inbound email. |
| approved_faq_series | DTO_stats_point[] | | Approved public FAQs per bucket - the bottom panel of the FAQ card. Empty until the
nightly snapshot job exists: FaqMongo has no approval timestamp, so history cannot be
reconstructed. The card falls back to rates-only and says when collection starts. |
| approved_faq_current | Int32 | | Approved public FAQs right now, which IS knowable and worth showing. |
| chat_outcome_series | DTO_stats_series[] | | Chat outcomes per bucket: resolved by bot, handed to a form, unrated. |
| missed_questions | DTO_stats_missed_question[] | | The visitor questions the bot could not answer. Empty until the audit-log rollup lands:
the events are recorded but are neither indexed by date nor grouped by phrasing. |
| automation_rules | DTO_stats_term[] | | Automation rule hit counts. Empty until the audit-log index lands. |
DTO_stats_period
| Name | Type | ReadOnly | Description |
|---|
| from | DateTime | | First day of the window, workspace-local. |
| to | DateTime | | Last day of the window, workspace-local. |
| previous_from | DateTime (nullable) | | First day of the comparison window. Null when not comparing. |
| previous_to | DateTime (nullable) | | Last day of the comparison window. Null when not comparing. |
| time_zone | String | | IANA id of the zone every bucket and boundary was cut in. |
| granularity | String | | "hour", "day" or "month" - the width of one point in every series below. |
| timeframe | ENUM dashboard_kpi_timeframe | | Which preset produced this window (CUSTOM when from/to were supplied). |
| compare | Boolean | | True when the previous-period figures are populated. |
DTO_stats_metric
| Name | Type | ReadOnly | Description |
|---|
| current | Double (nullable) | | Current |
| previous | Double (nullable) | | The same figure over the previous window. Null when not comparing, or when there is no history. |
DTO_stats_series
| Name | Type | ReadOnly | Description |
|---|
| key | String | | Stable key the frontend maps to a colour and a translated label. |
| label | String | | Server-side fallback label, used when the key is dynamic (a group or status name). |
| points | DTO_stats_point[] | | Points |
DTO_stats_point
| Name | Type | ReadOnly | Description |
|---|
| label | String | | Short human label for the axis ("Jul 20", "10:00", "Jul 2026"). |
| date | DateTime | | Start of the bucket, workspace-local. |
| value | Double (nullable) | | Null means "no data in this bucket", which a chart draws as a gap, not a zero. |
DTO_stats_missed_question
| Name | Type | ReadOnly | Description |
|---|
| question | String | | Question |
| count | Int32 | | Count |
| last_asked | DateTime (nullable) | | Last asked |
DTO_stats_term
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | Entity id when the term refers to one (group, status, mailbox); 0 otherwise. |
| key | String | | Stable key for terms that are enums rather than entities ("EMAIL", "CHAT_BOT"). |
| label | String | | Label |
| count | Int32 | | How many tickets fell into this term. |
| previous_count | Int32 (nullable) | | The term's own count in the comparison window. Null when not comparing. |
| value | Double (nullable) | | A secondary metric where the card shows one (average seconds, a percentage). |
ENUM dashboard_kpi_timeframe
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | TODAY | TODAY |
| 2 | YESTERDAY | YESTERDAY |
| 3 | THIS_WEEK | THIS_WEEK |
| 4 | LAST_4_WEEKS | LAST_4_WEEKS |
| 5 | LAST_12_WEEKS | LAST_12_WEEKS |
| 6 | ALL_TIME | ALL_TIME |
| 7 | CUSTOM | Stats only: the caller supplies from and to instead. Resolving this without dates is
an error, so the shared GetTimeFrame() extension deliberately refuses it. |
| 8 | LAST_12_MONTHS | LAST_12_MONTHS |
Generated Aug 4, 2026 18:37
