---
title: "The film's public link, whether it is ready to share, and how it is watched (free)"
method: GET
path: "/v1/storyboards/{id}/share"
tags: ["Storyboards"]
---

# The film's public link, whether it is ready to share, and how it is watched (free)

`GET /v1/storyboards/{id}/share`

## Request

- Base URL: `https://nanostudiopro.com/api`
- URL: `https://nanostudiopro.com/api/v1/storyboards/{id}/share`
- Auth: HTTP bearer

`share` is null until the film is shared. `stats`: views, viewers, finishes, the share reaching each ending, where viewers stop, the split at each decision. `readiness.missing` lists each segment that still has no finished active take (`where`: "Moments 2 to 3", `paths`: the 1-based paths it is on). `share.inSync` is false when the storyboard changed after the last share.

## Response `200`

The share and the readiness

- StoryboardShareAnswer: A film's public link. Its keys are camelCase, as the page reads them.
  - `share` object, nullable
    - `token` string
    - `url` string, uri: The public page.
    - `expiresAt` string, date-time, nullable
    - `hasPassword` boolean
    - `viewCount` integer
    - `frozenAt` string, date-time, nullable
    - `inSync` boolean: false: the storyboard changed after it was shared.
  - `readiness` object
    - `ready` boolean
    - `missing` object[]
      - `segmentId` string
      - `where` string
      - `paths` integer[]
  - `stats` object, nullable: GET only; null until shared. How the public film is watched, counted per viewer without an account (a first-party cookie), from their first Play. Counts only. Shares are 0-1.
    - `views` integer: Times Play was pressed.
    - `viewers` integer: Viewers who pressed Play.
    - `finishes` integer: Viewings watched to an ending.
    - `finishedViewers` integer
    - `endings` object[]
      - `panelId` string
      - `moment` integer
      - `title` string, nullable
      - `viewers` integer
      - `share` number
    - `stops` object[]: Viewers who never reached an ending, by the moment they were last at.
      - `panelId` string
      - `moment` integer
      - `viewers` integer
    - `decisions` object[]: Each decision's split of first choices.
      - `decisionId` string
      - `panelId` string
      - `moment` integer
      - `chose` integer
      - `options` object[]
        - `optionId` string
        - `label` string
        - `count` integer
        - `share` number

## Other responses

- `401`: Missing or invalid token
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/nanostudiopro/apis/nano-studio-pro-api.md) · [All operations](https://skmtc.dev/nanostudiopro/apis/nano-studio-pro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nanostudiopro/apis/nano-studio-pro-api/revisions/b454211e598e?raw)