# fyi.opensocial.previewPublicPage

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.previewPublicPage)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.previewPublicPage/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.previewPublicPage/examples)

## Definitions

### `fyi.opensocial.previewPublicPage`

**Type**: `query`

A tab's public page as the code the caller's assistant left for it would build it, before it's published: the whole page, under the site's header, at a path under the page's address. Only for whoever may change the group's site, and only their own draft.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `channel` | `string` | Yes | The tab's channel. |
| `group` | `string` (did) | Yes |  |
| `path` | `string` | No | Where under the page's address: "/", the default, or "/2026/coast". |
| `tab` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `address` | `string` | No | The page's address on the group's site. |
| `html` | `string` | Yes | The page; for one that isn't HTML (a feed), what it sends. |
| `status` | `integer` | Yes |  |

#### Errors

- **NotFound**
- **Forbidden**
- **MethodFailed**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A tab's public page as the code the caller's assistant left for it would build it, before it's published: the whole page, under the site's header, at a path under the page's address. Only for whoever may change the group's site, and only their own draft.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "Forbidden"
        },
        {
          "name": "MethodFailed"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "address": {
              "description": "The page's address on the group's site.",
              "type": "string"
            },
            "html": {
              "description": "The page; for one that isn't HTML (a feed), what it sends.",
              "type": "string"
            },
            "status": {
              "type": "integer"
            }
          },
          "required": [
            "status",
            "html"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "channel": {
            "description": "The tab's channel.",
            "type": "string"
          },
          "group": {
            "format": "did",
            "type": "string"
          },
          "path": {
            "description": "Where under the page's address: \"/\", the default, or \"/2026/coast\".",
            "maxLength": 500,
            "type": "string"
          },
          "tab": {
            "type": "string"
          }
        },
        "required": [
          "group",
          "channel",
          "tab"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.previewPublicPage",
  "lexicon": 1
}
```