Insights

Insights in GitBook are the entity for analytics coming from a site.

`GET` content analytics for a specific space

Get content analytics for a given space.

GEThttps://api.gitbook.com/v1/spaces/{spaceId}/insights/content

Authorization

Path parameters

spaceId*string

The unique id of the space

Response

Content analytics per page.

Body

pages*array of AnalyticsContentPage (object)

Request

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/insights/content', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "pages": [
    {
      "page": {
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "icon": "gear",
        "createdAt": "2025-01-25T00:53:17.161Z",
        "updatedAt": "2025-01-25T00:53:17.161Z",
        "markdown": "text",
        "type": "document",
        "urls": {
          "app": "https://example.com"
        },
        "slug": "text",
        "path": "text",
        "description": "text",
        "documentId": "text",
        "pages": [],
        "git": {
          "oid": "text",
          "path": "text"
        },
        "layout": {
          "cover": false,
          "coverSize": "hero",
          "title": false,
          "description": false,
          "tableOfContents": false,
          "outline": false,
          "pagination": false
        },
        "cover": {
          "ref": {
            "kind": "file",
            "file": "text"
          },
          "yPos": 0
        },
        "hidden": false,
        "noIndex": false,
        "noRobotsIndex": false,
        "computed": {
          "integration": "text",
          "source": "text",
          "props": {},
          "dependsOn": [
            {
              "kind": "space",
              "space": "text"
            }
          ]
        }
      },
      "pageViews": 0,
      "feedbacks": {
        "score": 0,
        "total": 0,
        "ponderedScore": 0,
        "bad": 0,
        "ok": 0,
        "good": 0
      }
    }
  ]
}

`GET` search analytics for a specific space

Get an overview of the top search queries in a space.

GEThttps://api.gitbook.com/v1/spaces/{spaceId}/insights/search

Authorization

Path parameters

spaceId*string

The unique id of the space

Query parameters

Response

Top queries searched on this space.

Body

searches*number

Number of searches done by users.

queries*array of AnalyticsSearchQuery (object)

`GET` page traffic analytics for a specific space

Get traffic page views for a given space

Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

GEThttps://api.gitbook.com/v1/spaces/{spaceId}/insights/traffic

Authorization

Path parameters

spaceId*string

The unique id of the space

Query parameters

Response

Traffic over time for the given space.

Body

count*number

Total number of page views over the period.

views*array of object

Page views per interval (day, week, month).

Request

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/insights/traffic', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "count": 0,
  "views": [
    {
      "timestamp": "text",
      "count": 0
    }
  ]
}

Last updated 1 year ago

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/insights/content', { method: 'GET', headers: { "Authorization": "Bearer <token>" }, }); const data = await response.json();

{ "pages": [ { "page": { "id": "text", "title": "text", "emoji": "🎉", "icon": "gear", "createdAt": "2025-01-25T00:53:17.161Z", "updatedAt": "2025-01-25T00:53:17.161Z", "markdown": "text", "type": "document", "urls": { "app": "https://example.com" }, "slug": "text", "path": "text", "description": "text", "documentId": "text", "pages": [], "git": { "oid": "text", "path": "text" }, "layout": { "cover": false, "coverSize": "hero", "title": false, "description": false, "tableOfContents": false, "outline": false, "pagination": false }, "cover": { "ref": { "kind": "file", "file": "text" }, "yPos": 0 }, "hidden": false, "noIndex": false, "noRobotsIndex": false, "computed": { "integration": "text", "source": "text", "props": {}, "dependsOn": [ { "kind": "space", "space": "text" } ] } }, "pageViews": 0, "feedbacks": { "score": 0, "total": 0, "ponderedScore": 0, "bad": 0, "ok": 0, "good": 0 } } ] }

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/insights/search', { method: 'GET', headers: { "Authorization": "Bearer <token>" }, }); const data = await response.json();

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/insights/traffic', { method: 'GET', headers: { "Authorization": "Bearer <token>" }, }); const data = await response.json();