Site preview

Fetch an up-to-date preview of your site before publishing.

Quickly generate a preview of how your site's content and layout will appear once published, allowing for final checks and refinement prior to going live.

Get a site preview URL

get

Generate a URL to preview the published content of a site. The URL will be valid for 1 hour.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

siteSpacestringOptional

ID of the site-space to preview. If not provided, the default site-space will be used.

claimsstringOptional

Rison encoded string of attributes/assertions about the visitor for which we want to preview the site.

draftbooleanOptional

Whether to include draft content in the preview. Defaults to true

Default: true

targetstringOptional

Target URL of the preview. If not provided, the default site preview URL will be used.

Responses

200

OK

application/json

urlstring · uri · max: 2048Required

400

Bad Request

application/json

get

/orgs/{organizationId}/sites/{siteId}/publishing/preview

HTTPcURLJavaScriptPython

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

{
  "url": "https://example.com"
}