> For the complete documentation index, see [llms.txt](https://docs.ibexa.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ibexa.ai/developers/rest-api/knowledge-base/get-overview.md).

# Get Overview

Get the Knowledge Base "overview" tab.

Reports six organisation-wide signals — total documents, content citations, total drafts, drafts older than 60 days, failed documents (parse or embedding failure), and documents with a duplicate (case-insensitive) name. Each metric carries its current total, the change against the count before the current calendar month, and (except `stale_drafts`, a snapshot with no time axis) a `group`-bucketed time series of new occurrences across `date_range`. Accessible by any member of the organisation.

```json
{"openapi":"3.1.0","info":{"title":"Ibexa Agentic Marketing Platform","version":"0.1.0"},"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/api/v1/login/access-token"}}}},"schemas":{"UsageGrouping":{"type":"string","enum":["TOTAL","DAY","MONTH","YEAR"],"title":"UsageGrouping","description":"Time-period granularity for aggregated execution usage."},"KnowledgeBaseOverviewResponseSchema":{"properties":{"total_documents":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema"},"content_citations":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema"},"total_drafts":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema"},"stale_drafts":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema","description":"Currently-open drafts older than 60 days. `series` is always null — this is a snapshot metric, not a flow."},"failed_documents":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema"},"doubled_documents":{"$ref":"#/components/schemas/KnowledgeBaseInsightMetricSchema"}},"type":"object","required":["total_documents","content_citations","total_drafts","stale_drafts","failed_documents","doubled_documents"],"title":"KnowledgeBaseOverviewResponseSchema","description":"Response schema for the Knowledge Base \"overview\" tab."},"KnowledgeBaseInsightMetricSchema":{"properties":{"value":{"type":"integer","title":"Value","description":"Current live count."},"previous_value":{"type":"integer","title":"Previous Value","description":"Count before the current calendar month started, the baseline `change`/`change_ratio` compare against."},"change":{"type":"integer","title":"Change","description":"`value` minus `previous_value`."},"change_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Change Ratio","description":"`change` as a fraction of `previous_value` (0.126 is a 12.6% rise). Null when `previous_value` is zero: growth from zero has no ratio — show `change` instead."},"series":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInsightPeriodSchema"},"type":"array"},{"type":"null"}],"title":"Series","description":"New occurrences per period across the requested date range, zero-filled. Null for metrics that are inherently a snapshot rather than a flow (currently only `stale_drafts`)."}},"type":"object","required":["value","previous_value","change","change_ratio"],"title":"KnowledgeBaseInsightMetricSchema","description":"A single overview metric: its current total, last month's baseline, and change."},"KnowledgeBaseInsightPeriodSchema":{"properties":{"period":{"type":"string","title":"Period","description":"The bucket's calendar label, formatted per the requested `group`."},"value":{"type":"integer","title":"Value","description":"Count of new occurrences in this period."}},"type":"object","required":["period","value"],"title":"KnowledgeBaseInsightPeriodSchema","description":"One bucket of an insight metric's time series."}}},"paths":{"/api/v1/knowledge-base/overview":{"get":{"tags":["knowledge-base","public"],"summary":"Get Overview","description":"Get the Knowledge Base \"overview\" tab.\n\nReports six organisation-wide signals — total documents, content\ncitations, total drafts, drafts older than 60 days, failed documents\n(parse or embedding failure), and documents with a duplicate\n(case-insensitive) name. Each metric carries its current total, the\nchange against the count before the current calendar month, and (except\n`stale_drafts`, a snapshot with no time axis) a `group`-bucketed time\nseries of new occurrences across `date_range`. Accessible by any member\nof the organisation.","operationId":"knowledge-base-get_overview","parameters":[{"name":"group","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/UsageGrouping"},{"type":"null"}],"description":"Time grouping granularity for each metric's series. If omitted, all activity in the range is aggregated into a single total.","title":"Group"},"description":"Time grouping granularity for each metric's series. If omitted, all activity in the range is aggregated into a single total."},{"name":"daterange","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date range as 'start,end' (ISO 8601 dates). Either part can be omitted, e.g. '2024-01-01,2024-12-31', '2024-01-01,' or ',2024-12-31'. A single date without a comma (e.g. '2024-01-01') is also accepted and sets date_from with an open-ended date_to.","title":"Daterange"},"description":"Date range as 'start,end' (ISO 8601 dates). Either part can be omitted, e.g. '2024-01-01,2024-12-31', '2024-01-01,' or ',2024-12-31'. A single date without a comma (e.g. '2024-01-01') is also accepted and sets date_from with an open-ended date_to."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseOverviewResponseSchema"}}}},"400":{"description":"Invalid request payload or parameters","content":{"application/json":{}}},"401":{"description":"User not authenticated","content":{"application/json":{}}},"403":{"description":"User lacks permission","content":{"application/json":{}}}}}}}}
```