On this page

Pages

The pages collection is the default multi-entry collection for storing website pages.


Definition

The collection includes the following fields, with required fields indicated by the R symbol:

FieldTypeDescription

path R

The unique URL path of the page. It always begins with a slash (/) and never ends with one (e.g., /about, /features/something, etc.). The sanitizers in place lowercase and normalize the input value.

public

Defines whether the page is publicly accessible. When set to false, the page will be in draft mode and can only be accessed using a randomly generated token. To access pages in draft mode, add the __d={draftToken} query parameter to the page's URL.

draftToken

The token that allows to access the draft version of the page. It is generated automatically and cannot be changed.

title

Defines the document's title that is shown in a browser's title bar or a page's tab.

baseTitle

Whether the base title defined in the SEO collection should be displayed together with the page title.

description

Specifying a description that includes keywords relating to the content of your page is useful as it has the potential to make your page appear higher in relevant searches performed in search engines.

visible

Discourage search engines from indexing this page.

sharingImage

An image that appears when someone shares this page link on a social network.

metaTags

The <meta> tags for this page. Values entered here will override other automatically generated meta tags defined in the SEO collection.

layout

The page layout.

publishDate

The publication date and time of the page. An internal job runs every 60 seconds to check for scheduled pages to publish.

blocks

An array of nestable blocks that make up the page content.

translations

An automatically generated unique identifier that groups records as translations of each other. When populated, this field resolves to a key-value object. The key represents he language code, and the value is the corresponding record's ID or null if no record in this language exists.

language

The language code associated with this collection record. If not provided, the code of the primary language will be used. Learn more about translations here.

createdAt

An automatically generated timestamp indicating when the page was created.

updatedAt

An automatically generated timestamp indicating when the page was last updated.

id

The unique identifier of the record.

Check out the collection definition on GitHub for more details.

Last updated on December 31, 2023 at 16:19