Skip to main content

Analytics

AI & LLM insights

How AI consumes your docs: crawler reads per AI family, which pages AI reads most, llms.txt / llms-full.txt / .md export fetch counts, AI assistant usage, and visits referred by AI tools. No bots param here — AI traffic is bot traffic by definition.

GET/projects/{id}/analytics/ai
AI & LLM insights
curl --request GET \
  --url 'https://api.nookdocs.com/v1/projects/{id}/analytics/ai' \
  --header 'Authorization: Bearer <token>'
{
  "pages": [
    {
      "path": "<string>",
      "views": 123
    }
  ],
  "range": {
    "to": "2023-11-07T05:31:56Z",
    "from": "2023-11-07T05:31:56Z"
  },
  "usage": {
    "llm_exports": 123,
    "ai_referrals": 123,
    "crawler_views": 123,
    "assistant_opens": 123,
    "assistant_messages": 123
  },
  "exports": [
    {
      "kind": "llms.txt",
      "count": 123
    }
  ],
  "crawlers": [
    {
      "views": 123,
      "family": "<string>"
    }
  ]
}

This is the AI & LLMs analytics card as an API — pull how GPTBot, ClaudeBot, and friends consume your docs into your own dashboards.

Authorizations

Authorizationstringheaderrequired

API key issued from your dashboard (Settings → API Keys). Format: nook_... — pass as Authorization: Bearer nook_.... Keys carry scopes (projects:read/write, pages:read, deployments:read/trigger, analytics:read) — calls without the required scope return 403.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstring (uuid)pathrequired
Project UUID

Query parameters

fromstring (date-time)query
Window start (inclusive), ISO 8601. Default: 30 days ago.
tostring (date-time)query
Window end (exclusive), ISO 8601. Default: now.
limitintegerquerydefault: 20
Maximum rows in the crawlers / pages / exports lists (1–100)

Response

application/json

AI consumption data for the window

pagesobject[]
Pages AI crawlers read most
rangeobject
usageobject
exportsobject[]
LLM export fetches by kind
crawlersobject[]
Views per AI crawler family, highest first