Insights

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

Last updated 8 days ago

Was this helpful?

Get content analytics for a given space.

Deprecated

This operation is deprecated and will be sunset on 2025-02-05.

get

/spaces/{spaceId}/insights/content

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/insights/content' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "pages": [
    {
      "page": {
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "icon": "gear",
        "createdAt": "2025-02-15T12:17:42.684Z",
        "updatedAt": "2025-02-15T12:17:42.684Z",
        "markdown": "text",
        "description": "text",
        "git": {
          "oid": "text",
          "path": "text"
        },
        "layout": {
          "coverSize": "hero",
          "cover": true,
          "title": true,
          "description": true,
          "tableOfContents": true,
          "outline": true,
          "pagination": true
        },
        "cover": {
          "ref": {
            "file": "text",
            "kind": "file"
          },
          "yPos": 1
        },
        "kind": "sheet",
        "type": "document",
        "slug": "text",
        "path": "text",
        "documentId": "text",
        "hidden": false,
        "noIndex": false,
        "noRobotsIndex": false,
        "computed": {
          "integration": "text",
          "source": "text",
          "props": "[Circular Reference]",
          "dependencies": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ref": {
                "space": "text",
                "kind": "space"
              }
            }
          }
        },
        "urls": {
          "app": "https://example.com"
        },
        "pages": [
          "[Circular Reference]"
        ]
      },
      "pageViews": 1,
      "feedbacks": {
        "score": 1,
        "total": 1,
        "rating": "text",
        "ponderedScore": 1,
        "bad": 1,
        "ok": 1,
        "good": 1
      }
    }
  ]
}

Content analytics per page.

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

Deprecated

This operation is deprecated and will be sunset on 2025-02-05.

get

/spaces/{spaceId}/insights/search

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

periodenum

Options: last_month, last_week, last_year

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/insights/search' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

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

Top queries searched on this space.

Get traffic page views for a given space

Deprecated

This operation is deprecated and will be sunset on 2025-02-05.

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.

get

/spaces/{spaceId}/insights/traffic

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

intervalenum

Options: daily, weekly, monthly

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/insights/traffic' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

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

Traffic over time for the given space.