Sign in
Practice Review Sweep

Start sweeping a kind of work on a cadence

Changed on

Authorises the recurring spend. The first sweep runs within the hour.

post/workspaces/{workspaceSlug}/practices/sweep-schedules

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Request body

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

Kind of work to sweep

cadence'DAILY' | 'WEEKLY' required

How often the sweep runs

lookbackDaysinteger required

How far back each sweep looks, in days

Example request

{
  "artifactKind": "scm.pull_request",
  "lookbackDays": 2
}

Response

Schedule created

artifactKindstring required
cadence'DAILY' | 'WEEKLY' required
createdAtstring date-time required
createdByAccountIdinteger required
enabledboolean required
idstring uuid required
lastRunAtstring date-time

When a campaign was last opened from this schedule; absent until the first one

lookbackDaysinteger required

how far back each sweep looks. Bounded at write time to twice the cadence and never more than a week, which is what keeps a sweep's observations admissible in the same trend line as reviews that events triggered.

nextRunAtstring date-time required

when the next sweep is due. Shown because it is the only way to tell a schedule that is working from one whose workspace has been skipping it.

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]$