Analytics

Monitor content performance with detailed usage metrics.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "pages": [
    {
      "page": "[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

periodstring · enum

Options: last_month, last_week, last_year

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

Top queries searched on this space.

Get page traffic and ratings for a given site space.

get

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

Authorizations

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 · enum

Options: last_month, last_week, last_year

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/insights/content' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "pages": [
    {
      "page": "[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 site.

get

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

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Query parameters

periodstring · enum

Options: last_month, last_week, last_year

siteSpaceIdsstring[]

The site spaces to filter the search on

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/insights/search' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

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

Top queries searched on this site.

Track a page view in a space

Deprecated

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

Track a page view in a space.

post

/spaces/{spaceId}/insights/track_view

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Body

pageIdstring

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.

visitorobjectrequired

Analytics info on the GitBook's content visitor.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/insights/track_view' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "pageId": "text",
    "url": "text",
    "referrer": "text",
    "visitor": {
      "anonymousId": "text",
      "ip": "text",
      "userAgent": "text",
      "language": "text",
      "cookies": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  }'

204

default

204

No body

Page view has been tracked.

Track a page view in a site

Deprecated

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

Track a page view in a site.

post

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

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/insights/track_view' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "pageId": "text",
    "url": "text",
    "referrer": "text",
    "visitor": {
      "anonymousId": "text",
      "ip": "text",
      "userAgent": "text",
      "language": "text",
      "cookies": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "spaceId": "text"
  }'

204

default

204

No body

Page view has been tracked.

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

intervalstring · enum

Options: daily, weekly, monthly

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

Traffic over time for the given space.