Get Beat Analysis

GET

/api/creative/plot/plotlines/{plotline_id}/beat-analysis

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Compare a plotline’s actual beat positions vs its assigned beat sheet targets.

Parameters

Path Parameters

plotline_id

required

Plotline Id

string

Responses

200

Successful Response

BeatAnalysisResponse

Beat analysis response.

object

status

required

Status

Operation status

string

data

required

BeatAnalysisData

Analysis payload

object

template

required

BeatSheetTemplate

The assigned template

object

id

required

Id

Template UUID

string

projectId

Any of:

string

string

null

null

name

required

Name

Template name

string

description

Description

Template description

string

""

source

Source

Attribution (e.g. ‘Blake Snyder’)

string

""

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

entries

required

Entries

Beat-by-beat comparison

Array<object>

BeatAnalysisEntry

Comparison of a plot point’s actual position vs. a beat sheet target.

object

beat

required

BeatSheetBeat

The target beat

object

id

required

Id

Beat UUID

string

templateId

required

Templateid

Parent template

string

name

required

Name

Beat name (e.g. ‘Catalyst’, ‘Midpoint’)

string

description

Description

Beat description

string

""

targetPercent

required

Targetpercent

Target position as % of story

number

<= 100

sortOrder

required

Sortorder

Sort position

integer

act

Any of:

integer

integer

null

null

mappedPoint

Any of:

PlotPoint

PlotPoint

A single plot point (beat) within a plotline.

object

id

required

Id

Plot point UUID

string

plotlineId

required

Plotlineid

Parent plotline

string

title

required

Title

Point title

string

description

Description

Point description

string

""

pointType

Pointtype

Beat type

string

default: beat

Allowed values: beat turning_point inciting_incident climax resolution setup escalation reversal

beatSheetPositionId

Any of:

string

string

null

null

intensity

Intensity

Arc intensity 0-100

integer

default: 50 <= 100

sortOrder

Sortorder

Sort position

integer

0

status

Status

Drafting status

string

default: planned

Allowed values: planned drafted revised final

notes

Notes

Private author notes

string

""

documentId

Any of:

string

string

null

null

wordCountTarget

Any of:

integer

integer

null

null

povType

Any of:

string

string

Allowed values: first_person second_person third_limited third_omniscient third_objective multiple_first deep_third stream_of_consciousness unreliable

null

null

povEntityId

Any of:

string

string

null

null

sceneType

Any of:

string

string

Allowed values: scene sequel hybrid flashback vision dream

null

null

sceneOutcome

Any of:

string

string

Allowed values: success failure partial disaster yes_but no_and pyrrhic unexpected

null

null

sourceNodeType

Any of:

string

string

Allowed values: series book part act chapter scene beat

null

null

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

null

null

actualPercent

Any of:

number

number

null

null

deviation

Any of:

number

number

null

null

coverage

required

Coverage

Percentage of beats with mapped points

number

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object