Skip to content
GitmoapAPIBeta
Schema

IterationView

An iteration and how it is going. The figures count only the work items you can see: an iteration may hold work from several repositories, and access to one of them reveals nothing about the others.

Shape

  • iterationIterationThe iteration.
    • The Iteration schema
    • created_atstringWhen it was created, ISO 8601.
    • due_dateCalendarDate (string)Its last day, included.
    • group_idGroupId (string · uuid)The group it belongs to.
    • iteration_idIterationId (string · uuid)The iteration's identifier.
    • start_dateCalendarDate (string)Its first day.
    • stateIterationStateupcomingcurrentclosedWhether it is upcoming, current or closed today, read from its dates — never stored.
    • titleIterationTitle (string)Its title.
    • updated_atstringWhen it last changed, ISO 8601.
    • cadence_idCadenceId (string · uuid) or nulloptionalThe cadence that generated it. Absent for an iteration created by hand, and for one whose cadence was deleted.
    • descriptionstring or nulloptionalWhat it is for, in Markdown. Absent when it has none.
    • sequenceinteger · int32 or nulloptional0–∞Its position in the cadence that generated it, counted from 1. Absent for an iteration created by hand.
  • rollupIterationRollupHow it is going.
    • The IterationRollup schema
    • cancelledinteger · int320–∞Those closed without being completed.
    • carry_overinteger · int320–∞Work items still open: what would carry over into the next iteration if this one ended now, and what did carry once it has ended.
    • carry_over_pointsinteger · int320–∞The points of the work items still open.
    • committed_pointsinteger · int320–∞The points of every work item in it that is not cancelled — what the iteration took on.
    • completedinteger · int320–∞Those completed.
    • completed_pointsinteger · int320–∞The points of its completed work items.
    • openinteger · int320–∞Those still open.
    • totalinteger · int320–∞Work items in the iteration.

Example

Synthesized example
{
"iteration": {
"created_at": "2026-10-15T16:31:51Z",
"due_date": "due-date-23f5",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iteration_id": "181ef0ff-a72c-4c49-b6a8-ef32c868f89a",
"start_date": "start-date-cbfe",
"state": "upcoming",
"title": "Stream pipeline status into the run header",
"updated_at": "2026-10-11T18:48:04Z",
"cadence_id": "50de7901-7c21-431f-a095-8b146bb97030",
"description": "Renders each region as density contours of its operations.",
"sequence": 48
},
"rollup": {
"cancelled": 9,
"carry_over": 47,
"carry_over_points": 41,
"committed_points": 33,
"completed": 9,
"completed_points": 74,
"open": 80,
"total": 7
}
}

Graph

Used inside

No schema contains this one.

Used by

Sent by 0 operations

No operation takes it as a request body.