Analytics

Get content analytics for a given space.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

Content analytics per page.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/insights/content

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/insights/content HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

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

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

periodstring · enumOptionalPossible values:

Responses

200

Top queries searched on this space.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/insights/search

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/insights/search HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get traffic page views for a given space

get

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.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

intervalstring · enumOptionalPossible values:

Responses

200

Traffic over time for the given space.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/insights/traffic

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/insights/traffic HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Track a page view in a space

post

Track a page view in a space.

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

application/json

pageIdstringOptional

Unique identifier of the page.

urlstringRequired

The GitBook content's URL visited (including URL params).

referrerstringRequired

The URL of referrer that linked to the page.

Responses

204

Page view has been tracked.

default

Unexpected Error

application/json

post

/spaces/{spaceId}/insights/track_view

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/insights/track_view HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "pageId": "text",
  "visitor": {
    "anonymousId": "text",
    "cookies": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "ip": "text",
    "userAgent": "text",
    "language": "text"
  },
  "url": "text",
  "referrer": "text"
}

No content

Get page traffic and ratings for a given site space.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteSpaceIdstringRequired

The unique id of the site-space relationship

Query parameters

periodstring · enumOptionalPossible values:

Responses

200

Content analytics per page.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/insights/content

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/insights/content HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Deprecated

Track a page view in a site

post

Track a page view in a site.

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Body

application/json

and

anyOptional

or

Responses

204

Page view has been tracked.

default

Unexpected Error

application/json

post

/orgs/{organizationId}/sites/{siteId}/insights/track_view

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/insights/track_view HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "pageId": "text",
  "visitor": {
    "anonymousId": "text",
    "cookies": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "ip": "text",
    "userAgent": "text",
    "language": "text"
  },
  "url": "text",
  "referrer": "text",
  "spaceId": "text"
}

No content

Get analytics insights of ads on a site.

get

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

intervalstring · enumOptional

The interval for grouping the results

Default: weekPossible values:

startstring · date-timeOptional

The earliest timestamp for any data returned

endstring · date-timeOptional

The latest timestamp for any data returned

Responses

200

The site's ads insights stats for the provided period.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/sites/{siteId}/insights/ads

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/insights/ads HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "date": "2026-01-25T23:51:26.200Z",
      "stats": {
        "impressions": 1,
        "clicks": 1,
        "revenue": "text"
      }
    }
  ],
  "account": {
    "email": "text",
    "url": "text"
  }
}

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

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

periodstring · enumOptionalPossible values:

siteSpaceIdsstring[]Optional

The site spaces to filter the search on

Responses

200

Top queries searched on this site.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/sites/{siteId}/insights/search

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/insights/search HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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