---
title: "Preview the page document"
method: GET
path: "/v1/projects/{projectId}/public-page/preview"
tags: ["Project Public Page"]
---

# Preview the page document

`GET /v1/projects/{projectId}/public-page/preview`

Builds the document from the current, possibly unpublished configuration so the owner can check every range before publishing.

## Path parameters

- `projectId` string, required

## Response `200`

Preview document

- PublicPagePayload
  - `schemaVersion` integer
  - `title` string
  - `description` string
  - `locale` string
  - `timeZone` string
  - `ranges` PublicPageRange[]
    - `key` string
    - `label` string
    - `from` integer
    - `to` integer
    - `stats` PublicPageStats
      - `trackedSeconds` integer
      - `activeDays` integer
      - `averageSecondsPerActiveDay` integer
      - `teamSize` integer
    - `distribution` PublicPageDistributionItem[]
      - `key` string
      - `label` string
      - `trackedSeconds` integer
      - `percentage` number, double
    - `activity` PublicPageActivity
      - `granularity` string
      - `points` PublicPageActivityPoint[]
        - `date` string
        - `trackedSeconds` integer
  - `defaultRangeKey` string
  - `assets` PublicPageAssetItem[]
    - `id` string
    - `type` string
    - `url` string
    - `fileName` string
    - `contentType` string
    - `size` integer
    - `caption` string
  - `links` PublicPageLink[]
    - `label` string
    - `url` string
  - `branding` PublicPageBranding
    - `name` string
    - `color` integer
  - `visibility` PublicPageVisibility
    - `showTrackedTime` boolean
    - `showActivity` boolean
    - `showDistribution` boolean
    - `showDescription` boolean
    - `showAssets` boolean
    - `showDocuments` boolean
    - `showLinks` boolean
    - `showTeamSize` boolean
  - `generatedAt` integer

## Other responses

- `401` — Not authorized
- `404` — No page or project not found

## Changes

> 8 revisions in range; 1 not diffed.

- **2026-09-06** `24f693bd6f1f` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/timesheet/apis/timesheet-api/changes/v1/projects/:projectId/public-page/preview/get.md)

---

[API](https://skmtc.dev/timesheet/apis/timesheet-api.md) · [All operations](https://skmtc.dev/timesheet/apis/timesheet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/timesheet/apis/timesheet-api/revisions/a3d2f44e7345?raw)