---
title: "What is in the knowledge base"
method: GET
path: "/stats"
---

# What is in the knowledge base

`GET /stats`

## Request

- Base URL: `https://vineverse.bible/api/v1`
- URL: `https://vineverse.bible/api/v1/stats`
- Auth: none required

The catalogue: every collection with its document count, folder, example path and a description of what it holds, plus graph totals and the most common tags. Call this first if you do not know what the knowledge base contains — it is the map to every other endpoint.

## Response `200`

Collections, counts, tags and provenance.

- Stats
  - `okfVersion` string
  - `notes` integer
  - `edges` integer
  - `tags` integer
  - `words` integer
  - `orphans` integer
  - `brokenLinks` integer
  - `verses` integer
  - `chapters` integer
  - `books` integer
  - `collections` object[]: Every collection, its size and how to page through it.
    - `type` string
    - `label` string
    - `count` integer
    - `folder` string
    - `route` string
    - `example` string
    - `description` string
  - `types` string[]
  - `topTags` object[]
  - `generated` string, date-time
  - `generatedNote` string
  - `licence` Licence: Carried on every response. The obligation is inherited by anyone who redistributes the data, not discharged by us. `document` is the licence of the specific document fetched, which is CC-BY-SA-4.0 for anything under sa/ and is the value to honour over the blanket statement.
    - `text` string
    - `data` string
    - `document` string: SPDX-style id for this document, e.g. "CC-BY-4.0".
    - `shareAlike` string
    - `reason` string
    - `attribution` string, uri

## Other responses

- `429`: Too many requests. Carries Retry-After. See the rate limit note in `info`.

---

[API](https://skmtc.dev/vineverse/apis/vineverse-api.md) · [All operations](https://skmtc.dev/vineverse/apis/vineverse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vineverse/apis/vineverse-api/revisions/39d053a686bb?raw)