Skip to content
Kindgi

A queue rule's results

View as Markdown
GET
/v1/projects/{projectId}/queue-rules/{ruleId}/results
curl --request GET \
  --url https://example.com/v1/projects/example/queue-rules/example/results \
  --header 'Authorization: Bearer <token>'

By the rule’s version and the agent’s: the runs it queued (open, corrected, dismissed, erased), the ones its maxOpen skipped, and the live corrections on them, with their group-weighted yes share and a count by group. Never pooled with another rule’s, or across a rule’s versions: each is a sample of its own when. Needs read on the project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

ProjectId — opaque branded string.

ruleId
required
string

Query Parameters

Section titled “Query Parameters”
since
string format: date-time

Only runs queued from this time on.

Responses

Section titled “Responses”

200

Section titled “200”

The results.

Media typeapplication/json
object
ruleId
required
string
since
string format: date-time
groups
required

By the rule’s version and the agent’s, newest rule version first: two versions of a rule are two sampling designs, never pooled.

Array<object>

One rule version’s runs of one agent version. added = open + corrected + dismissed + erased.

object
ruleVersion
required
integer
>= 1
agentVersion
required

null: a flow run, or one from before versions were recorded.

string | null
added
required
integer
open
required
integer
corrected
required
integer
dismissed
required
integer
erased
required
integer
skippedByCap
required

Runs the rule matched and sampled but didn’t queue, because maxOpen were waiting, even when another rule queued them. Non-zero: the queued runs lean toward quiet times. added + skippedByCap = every run the rule matched and sampled.

integer
corrections
required

Live corrections on the queued runs: each is one person’s verdict on one item of a run’s output.

integer
runsWithCorrections

The queued runs with at least one live correction: the runs corrections and yesShare come from, whatever their item’s state now (still open, closed as corrected, or dismissed after someone corrected it). Several people correcting one run make several corrections but one run here. Absent from a runtime that doesn’t count them.

integer
yesShare
required

The yes share of those corrections, each weighted by its group (no group: 1). null with none.

number | null
byGroup
required

The same corrections by group, unweighted.

Array<object>
object
correctorGroupId
required

null: unclassified.

string | null
corrections
required
integer
yes
required
integer
Examplegenerated
{
  "ruleId": "example",
  "since": "2026-04-15T12:00:00Z",
  "groups": [
    {
      "ruleVersion": 1,
      "agentVersion": "example",
      "added": 1,
      "open": 1,
      "corrected": 1,
      "dismissed": 1,
      "erased": 1,
      "skippedByCap": 1,
      "corrections": 1,
      "runsWithCorrections": 1,
      "yesShare": 1,
      "byGroup": [
        {
          "correctorGroupId": "example",
          "corrections": 1,
          "yes": 1
        }
      ]
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No such rule (queue-rule-not-found).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also