Skip to content
Book a demoStart free
Connectors

GitBook connector

Set up the GitBook connector in Kaivo: authentication, configuration, the 5 BigQuery tables it syncs, and answers to common questions.

GitBook connector pricing, tier and credits on kaivo.io

Kaivo is a fully managed data platform that syncs your GitBook data into a Google BigQuery warehouse and keeps it up to date automatically. There is no pipeline to build and no infrastructure to run, so you can spend your time analysing your data from GitBook instead of moving it.

Sync your GitBook documentation data into BigQuery with Kaivo to analyse content inventory, reader traffic, and page-level access.

CategoryTech, Files & Databases
AuthenticationAPI key
SetupSelf-service

Getting started with the GitBook connector

Section titled “Getting started with the GitBook connector”
  1. Sign up for Kaivo and create a workspace.
  2. Connect your GitBook account.
  3. Choose which tables to sync.
  4. Wait for the initial sync to finish.
  5. Query your data in BigQuery or your favourite AI or BI tool.

Authenticate with your Access Token.

Field Description
Access Token
Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.

|

When you set up the connector, you provide:

Field Description
Space ID
The unique identifier of the GitBook space to sync data from. You can find this in the space URL or in the GitBook developer settings.

|

Kaivo syncs 5 tables from GitBook into a dedicated dataset in your BigQuery warehouse. Click any table to see its columns and types.

content (21 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING
cover__ref__kind STRING
cover__ref__url STRING
cover__y_pos FLOAT64
document_id STRING
icon STRING
id STRING
kind STRING
layout__description BOOL
layout__cover BOOL
layout__cover_size STRING
layout__outline BOOL
layout__pagination BOOL
layout__table_of_contents BOOL
layout__title BOOL
path STRING
slug STRING
title STRING
urls__app STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
Column Type Description
_kaivo_parent_id STRING Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo.
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING
document_id STRING
icon STRING
id STRING
kind STRING
layout__description BOOL
layout__cover BOOL
layout__cover_size STRING
layout__outline BOOL
layout__pagination BOOL
layout__table_of_contents BOOL
layout__title BOOL
path STRING
slug STRING
title STRING
urls__app STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
Column Type Description
_kaivo_parent_id STRING Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo.
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
value JSON
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
insights_traffic (4 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
count FLOAT64
timestamp STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
org_members (17 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
disabled BOOL
id STRING
joined_at STRING
last_seen_at STRING
object STRING
role STRING
spaces FLOAT64
sso BOOL
teams FLOAT64
user__display_name STRING
user__email STRING
user__id STRING
user__object STRING
user__photo_url STRING
user__urls__location STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
organizations (13 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING
created_at STRING
default_role STRING
id STRING
invite_links BOOL
object STRING
plan STRING
title STRING
urls__app STRING
urls__location STRING
use_case STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
Column Type Description
_kaivo_parent_id STRING Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo.
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
value JSON
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
users (8 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
display_name STRING
email STRING
id STRING
object STRING
photo_url STRING
urls__location STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

After the first load, Kaivo keeps your BigQuery warehouse up to date for you. Where GitBook supports it, each sync pulls only new and changed records so it stays fast; otherwise it refreshes the whole table. Every record keeps its original ID, so you won’t get duplicate rows.

How long does the initial sync take for GitBook?

Section titled “How long does the initial sync take for GitBook?”

It depends on how much history is in your GitBook account. Most initial syncs finish within minutes, while large accounts can take a few hours. After that, syncs only fetch new and changed records, so they’re much faster.

Yes. You pick which tables to sync when you set up the connection and can change the selection later. Tables you don’t select are never copied to your warehouse.

What happens when GitBook’s schema changes?

Section titled “What happens when GitBook’s schema changes?”

New fields are never added automatically. You choose which fields to sync, so data you haven’t selected (sensitive personal data, for example) never lands in your warehouse. When a new field appears, it becomes available for you to add. What happens to removed or renamed fields depends on a table’s sync mode: full-refresh tables always match what’s currently in GitBook, so dropped fields disappear, while incremental tables keep their existing columns and history, so an old field stays and newly added fields fill in over time.

How do I handle GDPR or data deletion requests?

Section titled “How do I handle GDPR or data deletion requests?”

Your data lives in your own Kaivo-managed BigQuery warehouse, so the most direct option is to delete or anonymise specific records right in BigQuery. If you delete data in GitBook instead, full-refresh tables drop it on the next sync, while incremental tables keep it, so you would remove the row in BigQuery or ask us to run a full refresh. To remove everything, delete the GitBook connector in Kaivo and all of its synced data is deleted with it.

Use insights_traffic to see which docs readers visit most.

Join content with organizations to document your knowledge base.

Use org_members to review who can edit your documentation.

Once GitBook data lands in your Kaivo-managed BigQuery warehouse, you can explore it with AI tools or any BI tool that connects to BigQuery. Here’s how the most common destinations work with GitBook data.

Use Kaivo’s MCP server to give Claude secure, workspace-scoped access to your data. Setup guide →

Microsoft’s BI tool with a native BigQuery connector. Supports direct query and scheduled refresh. Setup guide →

Free Google BI tool with native BigQuery support. One-click connection to your Kaivo warehouse; great for SMB teams on Google Workspace. Setup guide →

The premium analytics standard, with native BigQuery integration. Setup guide →

Use Connected Sheets to query BigQuery directly from a spreadsheet, with no SQL. Setup guide →

Connect via Power Query’s BigQuery connector. Setup guide →

Open-source BI tool with strong BigQuery support. Setup guide →

See our pricing page for GitBook connector pricing and plan details.