Sign in
Practice Review Backfill

Enumerate and price a backfill campaign

Changed on

Creates a run awaiting confirmation. Submits nothing and spends nothing.

post/workspaces/{workspaceSlug}/practices/backfill-runs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/backfill-runs
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Request body

artifactKind'scm.pull_request' | 'scm.issue' required

Kind of work to review

fromAtstring date-time required

Window start, inclusive, over the artifact's creation time

toAtstring date-time required

Window end, exclusive

Example request

{
  "artifactKind": "scm.pull_request"
}

Response

Scope enumerated and priced

artifactKindstring required
confirmedByAccountIdinteger

Who authorised the spend; absent until the run is confirmed

createdAtstring date-time required
discoveredVia'EVENT' | 'SYNC' | 'MANUAL' | 'BACKFILL' | 'SWEEP' required

BACKFILL for a campaign an admin scoped by hand, SWEEP for one a recurring schedule opened

estimatedArtifactsinteger required
estimatedCostUsdnumber

Forecast total spend in USD; absent when the workspace has no priced review history

failedCountinteger required

artifacts whose submission threw, leaving no job and no recorded decision. Non-zero means this campaign's baseline has holes in it, which is why it is reported apart from a pass.

finishedAtstring date-time
fromAtstring date-time required
idstring uuid required
passedCountinteger required

artifacts walked past without one: already measured at their current state, or refused by the review gate. The campaign looked at each of these and decided.

pauseReason'BUDGET_EXHAUSTED' | 'REVIEW_MODEL_UNBOUND' | 'WORKSPACE_UNAVAILABLE'

Set only while the run is PAUSED

requestedByAccountIdinteger required
startedAtstring date-time
status'AWAITING_CONFIRMATION' | 'RUNNING' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' required
submittedCountinteger required

artifacts for which a review job was created

sweepScheduleIdstring uuid

The schedule that opened this run; absent for a campaign an admin scoped by hand

toAtstring date-time required

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$