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

user

Path parameters

spaceId*string

The unique id of the space

Response

200default

Content analytics per page.

Body

application/json

pages*array of AnalyticsContentPage (object)

Request

JavaScriptCurl

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": "🎉",
        "createdAt": "2024-04-26T05:10:11.736Z",
        "updatedAt": "2024-04-26T05:10:11.736Z",
        "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
        }
      },
      "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

user

Path parameters

spaceId*string

The unique id of the space

Query parameters

Response

200default

Top queries searched on this space.

Body

application/json

searches*number

Number of searches done by users.

queries*array of AnalyticsSearchQuery (object)

Top queries searched for this content.

Request

JavaScriptCurl

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

Response

{
  "searches": 0,
  "queries": [
    {
      "query": "text",
      "searches": 0,
      "hits": 0,
      "pageHits": 0,
      "sectionHits": 0
    }
  ]
}

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

user

Path parameters

spaceId*string

The unique id of the space

Query parameters

Response

200default

Traffic over time for the given space.

Body

application/json

count*number

Total number of page views over the period.

views*array of object

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

Request

JavaScriptCurl

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
    }
  ]
}