Skip to content
The API may change between versions while TTX-Zone is 0.x.

Get summary

GET
/api/v1/ttx/{ttx_id}/run/summary

How the session went, for its Controllers, Planners and Lead Evaluator (the ones who run the hot wash and write the report).

Successful Response

Media typeapplication/json
RunSummaryRead

How the session went, for its Controllers, Planners and Lead Evaluator: time played, injects, expected actions, key questions, ratings, notes – and what comes after, dated.

object
actions
required
Actions
object
key
additional properties
integer
ended_at
required
Any of:
string format: date-time
injects
required
Injects
Array<object>
RunSummaryInjectRead
object
code
required
Code
string
kind
required
InjectKind
string
Allowed values: mandatory contingent
reason
required
Reason
string
state
required
State
string
Allowed values: pending released skipped
title
required
Title
string
levels
required
Levels
object
key
additional properties
integer
milestones
required
Milestones
Array<object>
RunMilestoneRead

A step after the session, dated from it by the plan’s calendar.

object
key
required
Key
string
Allowed values: hot_wash debrief ratings_due draft_aar after_action_meeting
on
required
On
string format: date
played_minutes
required
Played Minutes
integer
questions_asked
required
Questions Asked
integer
questions_covered
required
Questions Covered
integer
ratings
required
Ratings
Array<object>
RunEvaluatorProgressRead
object
name
required
Name
string
rated
required
Rated
integer
total
required
Total
integer
started_at
required
Started At
string format: date-time
state
required
State
string
Allowed values: not_started live paused ended stopped
stop_reason
required
Stop Reason
string
team_notes
required
Team Notes
integer

Example

{
"injects": [
{
"kind": "mandatory",
"state": "pending"
}
],
"milestones": [
{
"key": "hot_wash"
}
],
"state": "not_started"
}