storyboards

One storyboard

The plan a render can be made from: the job envelope (state, pollAfterMs, and progress, the current step and whole percent while it plans), the beats with a short-lived screenshot URL each, the steps the run could not resolve, the hint-coverage report — what the hint asked for that the beats do not show — and lengthFit, what the chosen length did to the plan. Poll until state is terminal, then read beats.

get/storyboards/{id}

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/storyboards/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Response

One storyboard

appEntryUrlstring nullable required

Where the walkthrough was actually recorded, when a sign-in proved the app is not at targetOrigin — a product at app.example.com for a site at example.com. Null means the two are the same place.

credentialsHeldboolean required

Whether the session credential the run used is still held server-side. The credential itself never leaves the server.

hadCredentialsboolean required
hintstring nullable required
stuckStepsobject[] required
summarystring nullable required
targetOriginstring nullable required
targetPathstring nullable required
titlestring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.