{"title":"Stats & KPI API","slug":"stats","category":"api","summary":"Statistics endpoints, fleet KPIs and tidy-long KPI export (CSV/JSON/XLSX) for LLM agents.","audience":["human"],"tags":[],"word_count":297,"read_minutes":1,"lang":"en","translated":true,"requested_lang":"en","content_markdown":"\n# Stats & KPI API\n\nSynapse exposes read-only statistics for agent health, API usage, trends and\nfleet KPIs. All endpoints accept either a MindKey (`Authorization: Bearer`)\nor a user JWT (`requireMindOrUser`).\n\nExisting analytics routes (see the `/stats` page in the WebUI):\n\n| Route | Purpose |\n| --- | --- |\n| `GET /stats/agent` | All agents overview (period: `days`) |\n| `GET /stats/agent/comparison` | Cross-agent comparison |\n| `GET /stats/agent/:mindName` | Detailed stats for one agent |\n| `GET /stats/agent/:mindName/health` | Health score |\n| `GET /stats/agent/:mindName/heatmap` | Activity heatmap |\n| `GET /stats/agent/:mindName/sessions` | Session tracker |\n| `GET /stats/api` | API usage (global) |\n| `GET /stats/trends` | Time series |\n| `GET /stats/chat/response-times` | Chat response times |\n| `GET /stats/a2a/flow` | A2A message flow |\n| `GET /stats/cron` | Cron analytics |\n| `GET /stats/team` · `/stats/backlog` · `/stats/activity` · `/stats/summary` · `/stats/fleet` · `/stats/monitoring` | Dashboard aggregates |\n\n## GET /export/kpis\n\nTidy-long export of the operational KPIs (task 7418541b). The data source of\ntruth is `src/db/stats.ts` — the export layer only flattens, it measures\nnothing itself.\n\n```\nGET /export/kpis?format=csv|json|xlsx&days=7\n```\n\n| Parameter | Values | Default |\n| --- | --- | --- |\n| `format` | `csv` · `json` · `xlsx` | `json` |\n| `days` | `1`–`365` (window for agent overview) | `7` |\n\nResponse:\n\n- `format=json` → `{ generated_at, period_days, format: \"long\", columns, row_count, rows[] }`\n- `format=csv` → `text/csv; charset=utf-8` (RFC 4180, BOM, CRLF) as attachment\n- `format=xlsx` → Excel workbook (single sheet `KPIs`) as attachment\n\nTidy-long columns (identical in all formats):\n\n| Column | Meaning |\n| --- | --- |\n| `kategorie` | KPI group: `fleet`, `summary`, `backlog`, `activity`, `team`, `monitoring`, `agent_overview` |\n| `metrik` | Flattened metric path (e.g. `throughput.done_24h_total`) |\n| `wert` | Scalar value (number, text or `NULL` when only `detail` carries data) |\n| `einheit` | `value` · `count` · `text` · `json` |\n| `zeitstempel` | ISO-8601 generation timestamp of the export |\n| `quelle` | Source function in `src/db/stats.ts` |\n| `detail` | JSON payload for arrays/deep objects, otherwise empty |\n\nExample:\n\n```bash\ncurl -s -H \"Authorization: Bearer $MIND_KEY\" \\\n  \"https://synapse.schaefer.zone/export/kpis?format=csv&days=7\" -o kpis.csv\n```\n\nThe WebUI `/stats` page renders the same export as three download buttons\n(CSV/JSON/XLSX) in the \"KPI export\" section.\n","content_html":"<h1>Stats &amp; KPI API</h1>\n<p>Synapse exposes read-only statistics for agent health, API usage, trends and\nfleet KPIs. All endpoints accept either a MindKey (<code>Authorization: Bearer</code>)\nor a user JWT (<code>requireMindOrUser</code>).</p>\n<p>Existing analytics routes (see the <code>/stats</code> page in the WebUI):</p>\n<table>\n<thead>\n<tr>\n<th>Route</th>\n<th>Purpose</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>GET /stats/agent</code></td>\n<td>All agents overview (period: <code>days</code>)</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/comparison</code></td>\n<td>Cross-agent comparison</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName</code></td>\n<td>Detailed stats for one agent</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/health</code></td>\n<td>Health score</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/heatmap</code></td>\n<td>Activity heatmap</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/sessions</code></td>\n<td>Session tracker</td>\n</tr>\n<tr>\n<td><code>GET /stats/api</code></td>\n<td>API usage (global)</td>\n</tr>\n<tr>\n<td><code>GET /stats/trends</code></td>\n<td>Time series</td>\n</tr>\n<tr>\n<td><code>GET /stats/chat/response-times</code></td>\n<td>Chat response times</td>\n</tr>\n<tr>\n<td><code>GET /stats/a2a/flow</code></td>\n<td>A2A message flow</td>\n</tr>\n<tr>\n<td><code>GET /stats/cron</code></td>\n<td>Cron analytics</td>\n</tr>\n<tr>\n<td><code>GET /stats/team</code> · <code>/stats/backlog</code> · <code>/stats/activity</code> · <code>/stats/summary</code> · <code>/stats/fleet</code> · <code>/stats/monitoring</code></td>\n<td>Dashboard aggregates</td>\n</tr>\n</tbody></table>\n<h2>GET /export/kpis</h2>\n<p>Tidy-long export of the operational KPIs (task 7418541b). The data source of\ntruth is <code>src/db/stats.ts</code> — the export layer only flattens, it measures\nnothing itself.</p>\n<pre><code class=\"hljs language-plaintext\">GET /export/kpis?format=csv|json|xlsx&amp;days=7</code></pre><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Values</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>format</code></td>\n<td><code>csv</code> · <code>json</code> · <code>xlsx</code></td>\n<td><code>json</code></td>\n</tr>\n<tr>\n<td><code>days</code></td>\n<td><code>1</code>–<code>365</code> (window for agent overview)</td>\n<td><code>7</code></td>\n</tr>\n</tbody></table>\n<p>Response:</p>\n<ul>\n<li><code>format=json</code> → <code>{ generated_at, period_days, format: &quot;long&quot;, columns, row_count, rows[] }</code></li>\n<li><code>format=csv</code> → <code>text/csv; charset=utf-8</code> (RFC 4180, BOM, CRLF) as attachment</li>\n<li><code>format=xlsx</code> → Excel workbook (single sheet <code>KPIs</code>) as attachment</li>\n</ul>\n<p>Tidy-long columns (identical in all formats):</p>\n<table>\n<thead>\n<tr>\n<th>Column</th>\n<th>Meaning</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>kategorie</code></td>\n<td>KPI group: <code>fleet</code>, <code>summary</code>, <code>backlog</code>, <code>activity</code>, <code>team</code>, <code>monitoring</code>, <code>agent_overview</code></td>\n</tr>\n<tr>\n<td><code>metrik</code></td>\n<td>Flattened metric path (e.g. <code>throughput.done_24h_total</code>)</td>\n</tr>\n<tr>\n<td><code>wert</code></td>\n<td>Scalar value (number, text or <code>NULL</code> when only <code>detail</code> carries data)</td>\n</tr>\n<tr>\n<td><code>einheit</code></td>\n<td><code>value</code> · <code>count</code> · <code>text</code> · <code>json</code></td>\n</tr>\n<tr>\n<td><code>zeitstempel</code></td>\n<td>ISO-8601 generation timestamp of the export</td>\n</tr>\n<tr>\n<td><code>quelle</code></td>\n<td>Source function in <code>src/db/stats.ts</code></td>\n</tr>\n<tr>\n<td><code>detail</code></td>\n<td>JSON payload for arrays/deep objects, otherwise empty</td>\n</tr>\n</tbody></table>\n<p>Example:</p>\n<pre><code class=\"hljs language-bash\">curl -s -H <span class=\"hljs-string\">&quot;Authorization: Bearer <span class=\"hljs-variable\">$MIND_KEY</span>&quot;</span> \\\n  <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone/export/kpis?format=csv&amp;days=7&quot;</span> -o kpis.csv</code></pre><p>The WebUI <code>/stats</code> page renders the same export as three download buttons\n(CSV/JSON/XLSX) in the &quot;KPI export&quot; section.</p>\n","urls":{"html":"/docs/api/stats","text":"/docs/api/stats?format=text","json":"/docs/api/stats?format=json","llm":"/docs/api/stats?format=llm"},"translations_available":["en","de"],"wordCount":297,"readMinutes":1,"requestedLang":"en","contentMarkdown":"\n# Stats & KPI API\n\nSynapse exposes read-only statistics for agent health, API usage, trends and\nfleet KPIs. All endpoints accept either a MindKey (`Authorization: Bearer`)\nor a user JWT (`requireMindOrUser`).\n\nExisting analytics routes (see the `/stats` page in the WebUI):\n\n| Route | Purpose |\n| --- | --- |\n| `GET /stats/agent` | All agents overview (period: `days`) |\n| `GET /stats/agent/comparison` | Cross-agent comparison |\n| `GET /stats/agent/:mindName` | Detailed stats for one agent |\n| `GET /stats/agent/:mindName/health` | Health score |\n| `GET /stats/agent/:mindName/heatmap` | Activity heatmap |\n| `GET /stats/agent/:mindName/sessions` | Session tracker |\n| `GET /stats/api` | API usage (global) |\n| `GET /stats/trends` | Time series |\n| `GET /stats/chat/response-times` | Chat response times |\n| `GET /stats/a2a/flow` | A2A message flow |\n| `GET /stats/cron` | Cron analytics |\n| `GET /stats/team` · `/stats/backlog` · `/stats/activity` · `/stats/summary` · `/stats/fleet` · `/stats/monitoring` | Dashboard aggregates |\n\n## GET /export/kpis\n\nTidy-long export of the operational KPIs (task 7418541b). The data source of\ntruth is `src/db/stats.ts` — the export layer only flattens, it measures\nnothing itself.\n\n```\nGET /export/kpis?format=csv|json|xlsx&days=7\n```\n\n| Parameter | Values | Default |\n| --- | --- | --- |\n| `format` | `csv` · `json` · `xlsx` | `json` |\n| `days` | `1`–`365` (window for agent overview) | `7` |\n\nResponse:\n\n- `format=json` → `{ generated_at, period_days, format: \"long\", columns, row_count, rows[] }`\n- `format=csv` → `text/csv; charset=utf-8` (RFC 4180, BOM, CRLF) as attachment\n- `format=xlsx` → Excel workbook (single sheet `KPIs`) as attachment\n\nTidy-long columns (identical in all formats):\n\n| Column | Meaning |\n| --- | --- |\n| `kategorie` | KPI group: `fleet`, `summary`, `backlog`, `activity`, `team`, `monitoring`, `agent_overview` |\n| `metrik` | Flattened metric path (e.g. `throughput.done_24h_total`) |\n| `wert` | Scalar value (number, text or `NULL` when only `detail` carries data) |\n| `einheit` | `value` · `count` · `text` · `json` |\n| `zeitstempel` | ISO-8601 generation timestamp of the export |\n| `quelle` | Source function in `src/db/stats.ts` |\n| `detail` | JSON payload for arrays/deep objects, otherwise empty |\n\nExample:\n\n```bash\ncurl -s -H \"Authorization: Bearer $MIND_KEY\" \\\n  \"https://synapse.schaefer.zone/export/kpis?format=csv&days=7\" -o kpis.csv\n```\n\nThe WebUI `/stats` page renders the same export as three download buttons\n(CSV/JSON/XLSX) in the \"KPI export\" section.\n","contentHtml":"<h1>Stats &amp; KPI API</h1>\n<p>Synapse exposes read-only statistics for agent health, API usage, trends and\nfleet KPIs. All endpoints accept either a MindKey (<code>Authorization: Bearer</code>)\nor a user JWT (<code>requireMindOrUser</code>).</p>\n<p>Existing analytics routes (see the <code>/stats</code> page in the WebUI):</p>\n<table>\n<thead>\n<tr>\n<th>Route</th>\n<th>Purpose</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>GET /stats/agent</code></td>\n<td>All agents overview (period: <code>days</code>)</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/comparison</code></td>\n<td>Cross-agent comparison</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName</code></td>\n<td>Detailed stats for one agent</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/health</code></td>\n<td>Health score</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/heatmap</code></td>\n<td>Activity heatmap</td>\n</tr>\n<tr>\n<td><code>GET /stats/agent/:mindName/sessions</code></td>\n<td>Session tracker</td>\n</tr>\n<tr>\n<td><code>GET /stats/api</code></td>\n<td>API usage (global)</td>\n</tr>\n<tr>\n<td><code>GET /stats/trends</code></td>\n<td>Time series</td>\n</tr>\n<tr>\n<td><code>GET /stats/chat/response-times</code></td>\n<td>Chat response times</td>\n</tr>\n<tr>\n<td><code>GET /stats/a2a/flow</code></td>\n<td>A2A message flow</td>\n</tr>\n<tr>\n<td><code>GET /stats/cron</code></td>\n<td>Cron analytics</td>\n</tr>\n<tr>\n<td><code>GET /stats/team</code> · <code>/stats/backlog</code> · <code>/stats/activity</code> · <code>/stats/summary</code> · <code>/stats/fleet</code> · <code>/stats/monitoring</code></td>\n<td>Dashboard aggregates</td>\n</tr>\n</tbody></table>\n<h2>GET /export/kpis</h2>\n<p>Tidy-long export of the operational KPIs (task 7418541b). The data source of\ntruth is <code>src/db/stats.ts</code> — the export layer only flattens, it measures\nnothing itself.</p>\n<pre><code class=\"hljs language-plaintext\">GET /export/kpis?format=csv|json|xlsx&amp;days=7</code></pre><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Values</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>format</code></td>\n<td><code>csv</code> · <code>json</code> · <code>xlsx</code></td>\n<td><code>json</code></td>\n</tr>\n<tr>\n<td><code>days</code></td>\n<td><code>1</code>–<code>365</code> (window for agent overview)</td>\n<td><code>7</code></td>\n</tr>\n</tbody></table>\n<p>Response:</p>\n<ul>\n<li><code>format=json</code> → <code>{ generated_at, period_days, format: &quot;long&quot;, columns, row_count, rows[] }</code></li>\n<li><code>format=csv</code> → <code>text/csv; charset=utf-8</code> (RFC 4180, BOM, CRLF) as attachment</li>\n<li><code>format=xlsx</code> → Excel workbook (single sheet <code>KPIs</code>) as attachment</li>\n</ul>\n<p>Tidy-long columns (identical in all formats):</p>\n<table>\n<thead>\n<tr>\n<th>Column</th>\n<th>Meaning</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>kategorie</code></td>\n<td>KPI group: <code>fleet</code>, <code>summary</code>, <code>backlog</code>, <code>activity</code>, <code>team</code>, <code>monitoring</code>, <code>agent_overview</code></td>\n</tr>\n<tr>\n<td><code>metrik</code></td>\n<td>Flattened metric path (e.g. <code>throughput.done_24h_total</code>)</td>\n</tr>\n<tr>\n<td><code>wert</code></td>\n<td>Scalar value (number, text or <code>NULL</code> when only <code>detail</code> carries data)</td>\n</tr>\n<tr>\n<td><code>einheit</code></td>\n<td><code>value</code> · <code>count</code> · <code>text</code> · <code>json</code></td>\n</tr>\n<tr>\n<td><code>zeitstempel</code></td>\n<td>ISO-8601 generation timestamp of the export</td>\n</tr>\n<tr>\n<td><code>quelle</code></td>\n<td>Source function in <code>src/db/stats.ts</code></td>\n</tr>\n<tr>\n<td><code>detail</code></td>\n<td>JSON payload for arrays/deep objects, otherwise empty</td>\n</tr>\n</tbody></table>\n<p>Example:</p>\n<pre><code class=\"hljs language-bash\">curl -s -H <span class=\"hljs-string\">&quot;Authorization: Bearer <span class=\"hljs-variable\">$MIND_KEY</span>&quot;</span> \\\n  <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone/export/kpis?format=csv&amp;days=7&quot;</span> -o kpis.csv</code></pre><p>The WebUI <code>/stats</code> page renders the same export as three download buttons\n(CSV/JSON/XLSX) in the &quot;KPI export&quot; section.</p>\n","translationsAvailable":["en","de"]}