Practice reviews

List practice reviews with observation and feedback outcomes

Changed on

Results are ordered newest first.

get/workspaces/{workspaceSlug}/practices/reviews

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

pageinteger
sizeinteger
statusstring[]

Statuses to list (repeatable); omit for every status

resultProcessingstring[]

Result-processing statuses to list (repeatable), such as FAILED for the reviews whose results can be processed again; omit for every review, including those without one

fromstring date-time

Inclusive lower bound on when the review was requested

tostring date-time

Exclusive upper bound on when the review was requested

subjectUserIdinteger

Keep the reviews that recorded an observation about this developer that is not marked incorrect

practiceSlugstring[]

Keep the reviews that recorded an observation of any of these practices that is not marked incorrect (repeatable)

groupSlugstring[]

Keep the reviews that recorded an observation of a practice in any of these groups that is not marked incorrect (repeatable)

agentJobIdstring uuid

Keep this one review

artifactKindstring

Keep the reviews of this kind of work, e.g. scm.pull_request

artifactIdinteger

Keep the reviews of this one piece of work; requires artifactKind

finishedAfterMergeboolean

True keeps the pull request and merge request reviews that completed after the work was merged; false or omitted keeps every review

onHoldboolean

True also keeps the queued reviews on hold, such as those waiting for the AI budget; alone it keeps only those. False or omitted adds nothing to the status filter

waitingboolean

True also keeps the queued reviews that wait for a worker now, as the queue counts them: not held for the AI budget and due now, not backing off before a retry. Alone it keeps only those. False or omitted adds nothing to the status filter

Response

Paginated review summaries returned

Changes

  • 80ad90d36e50Revision changes
    • info

      added the new optional query request parameter agentJobId

    • info

      added the new optional query request parameter artifactId

    • info

      added the new optional query request parameter artifactKind

    • info

      added the new optional query request parameter finishedAfterMerge

    • info

      added the new optional query request parameter groupSlug

    • info

      added the new optional query request parameter onHold

    • info

      added the new optional query request parameter practiceSlug

    • info

      added the new optional query request parameter subjectUserId

    • info

      added the new optional query request parameter waiting

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

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