microCMS
Documentation
  • Pricing
  • Blog
  • FAQ
  • Contact
  • Sign In
  • Get started for free
Navigation
Tutorial
Next.js
  • Integration with Next.js
  • Getting Started with App Router
  • Tutorial (App Router)
  • Getting Started with Pages Router
  • Tutorial (Pages Router)
Astro
  • Getting Started
  • Integration with Astro
  • Tutorial
Nuxt
  • Integration with Nuxt
  • Getting Started
  • Tutorial
Gatsby
  • Integration with Gatsby
  • Getting Started
  • Tutorial
JavaScript
  • Integration with JavaScript
  • Getting Started (Browser)
  • Getting Started (Server)
PHP
  • Integration with PHP
  • Getting Started
Ruby
  • Integration with Ruby
  • Getting Started
Go
  • Integration with Go
  • Getting Started with microCMS
Manual
  • Introduction
Account & Login
  • Account Registration
  • Login
  • Email Address Authentication
Services
  • Creating a Service
  • Service Configuration
  • Template
  • Service Deletion
Payment
  • Change of Pricing Plan
  • Registering and Changing Payment Methods
API
  • Creating and Managing APIs
  • API Settings
  • Export/Import of API Schema
Fields
  • Text Field
  • Text Area
  • Image
  • Multiple Images
  • Date
  • Boolean
  • Selectable Field
  • Content Reference
  • Multiple Content References
  • Number
  • File
  • Extended Field
  • Repetition
  • Custom
Contents
  • CSV Export of Content
  • Content Creation
  • Content Editing
  • Content Management
  • View
  • Content Status
  • Custom Status
  • Setting the Content ID
  • Automatically Assigned Values for Content
  • CSV Import of Content
  • API Preview
  • Examples of Using Query Parameters with API Preview
  • Integration Methods by Rendering Type
  • Screen Preview
  • Setting Up Webhooks for Content
Rich Editor
  • How to Use the Rich Editor
  • Rich Editor WRITE API
  • How to Use the Old Rich Editor
Reviews
  • Review
  • AI Review
Media
  • Media Management
  • Changing Media Filters and Display Order
  • Media Tag Configuration
  • Setting Up Media Webhooks
  • Custom Domain Settings for Media
Permission Management
  • Member Management
  • Roles (Permission Management in the Admin Panel)
Environments
  • Multiple Environments (Development Environment)
  • Merging API Settings Between Environments
Connection
  • Amazon S3 Integration
Logs
  • Audit Log
  • Data Transfer Volume
Security
  • Content Update History
  • IP Restrictions for Management Dashboard
  • IP Restrictions for APIs
Authentication
  • Setting Up Two-Factor Authentication
  • Mandatory Two-Factor Authentication
  • Single Sign-On
Specifications & Limitations
  • Recommended Environment
  • Limitations / Precautions
Content API
  • What is the Content API?
Basic Operations
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
API Keys
  • API Key (API Authentication and Authorization Management)
  • Migration from the Old API (X-API-KEY, etc.)
Responses & Error Handling
  • Response format for each field in the GET API
  • Specifying Query Parameters in the GET API
  • Error Responses of the Content API
Management API (Beta)
  • POST /api/v1/roles
  • DELETE /api/v1/roles/{role_id}
  • GET /api/v1/roles/{role_id}
  • PATCH /api/v1/roles/{role_id}
  • GET /api/v1/roles
  • What is the Management API?
Content Operations
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
Media Operations
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
Member Operations
  • PATCH /api/v1/members/{member_id}
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API Operations
  • POST /api/v1/apis
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
Service Operations
  • GET /api/v1/service
Responses & Error Handling
  • Management API Error Responses
Image API
  • What is the Image API?
Parameters
  • Image Size
  • Quality
  • Resolution and Screen Size
  • Format
  • Text
  • Border
  • Padding
  • Shape
  • Download
  • Watermark
MCP Server
  • microCMS MCP
  • microCMS Document MCP Server
  • Top
  • Manual

Screen Preview

Last updated: 2026/11/12

Page Preview is a feature that lets you check content registered in the Administration console on your website before publishing it.

How Preview Works

First, microCMS is a headless CMS with no built-in presentation layer, so its preview mechanism is fundamentally different from that of traditional CMSs.

To preview content, you need to implement a mechanism on the frontend to retrieve Draft content from microCMS and render it.
To do this, you need to pass the frontend a URL containing the Content ID, which uniquely identifies the content, and the draftKey, which is used to retrieve the Draft content.



microCMS provides a Page Preview feature that lets you configure a dynamic URL for previews from the content details screen in the Administration console. This document explains how to configure it.

How to Configure Page Preview

1: Select an API.
2: Select "API Settings."
3: Select "Page Preview."



4: Enter the URL you want to link to in the "Destination URL" field, then click "Update."



When you include the following placeholders in the URL, they are replaced with values from the content being previewed when you run Page Preview.

  • {CONTENT_ID}: Content ID
  • {DRAFT_KEY}: draftKey
  • {FIELD:Field ID}: The value of the specified Field

Including Field values in the URL
You can specify the following Fields in {FIELD:Field ID}. Field IDs are case-sensitive.

  • Text Field
  • Number Field
  • Selectable Field (single selection only)
  • Content Reference Field (only the Content ID of the referenced content)

For example, to include the value of a Text Field with the Field ID slug in the URL, enter {FIELD:slug}.
Example: https://example.com/{FIELD:slug}/draft?id={CONTENT_ID}&draftKey={DRAFT_KEY}

Specifying a Content Reference Field
For a Content Reference Field, you can include the Content ID of the referenced content in the URL by adding .id after the Field ID.
For example, if the Field ID is category, enter {FIELD:category.id}.
Example: https://example.com/{FIELD:category.id}/draft?id={CONTENT_ID}&draftKey={DRAFT_KEY}
You cannot specify Field values other than the Content ID or Multiple Content References Fields.

After configuring the URL, click the [Page Preview] button on the content details screen. The placeholders in the URL are replaced with values from the selected content, and you are redirected to that URL.



On the frontend, you can retrieve these values from the URL and use them to access the microCMS API and fetch the data.

Frontend Implementation

For details on how to implement the frontend, see the following blog articles.

microCMSとNuxtでプレビュー画面を作成する | microCMSブログ
https://blog.microcms.io/nuxt-jamstack-preview/
microCMSとGatsbyでプレビュー画面を作成する | microCMSブログ
https://blog.microcms.io/gatsby-preview/
AstroとmicroCMSを使った画面プレビューを実装する | microCMSブログ
https://blog.microcms.io/astro-preview/

Contents

  • How Preview Works
  • How to Configure Page Preview
  • Frontend Implementation
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.