Skip to main content

Field Review Summary

Get queue counts for dashboards: the total number of fields awaiting review plus per-trigger and per-pipeline breakdowns.

Get cheap counts for the field-review queue, sized for a dashboard badge or a periodic poll. The response is the total number of fields currently awaiting review, plus a breakdown by trigger (gate versus declarative) and a breakdown by pipeline. This is the count behind a "fields to review" nav badge.

The summary is deliberately lightweight: it counts rows without loading cell values, verdicts, or the classified reasons that the list and triage views compute. Use it to decide whether there is review work to do at all, then call GET /v1/field-reviews to fetch the actual items when the total is non-zero.

The byTrigger map gives counts keyed by trigger, so you can tell a queue of failed gates apart from a queue of declarative holds. The byPipeline array gives one entry per run with its name and count, so you can route review work to the right owner. All counts are scoped to your organization. This endpoint requires an API key with the read scope.

This endpoint is built for frequent polling. It counts rows only and never loads cell values or verdicts, so it stays cheap even when the queue is large.
GET/v1/field-reviews/summary

Response

Response fields

totalintegerTotal fields currently awaiting review.
byTriggerobjectCounts keyed by trigger (gate, declarative).
byPipelinearrayPer-pipeline breakdown.
byPipeline[].pipelineIdstringPipeline run UUID.
byPipeline[].pipelineNamestringRun name.
byPipeline[].countintegerFields awaiting review in this run.

Response

{
  "total": 14,
  "byTrigger": {
    "gate": 11,
    "declarative": 3
  },
  "byPipeline": [
    {
      "pipelineId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "pipelineName": "Lease Agreement — 2024-09-14",
      "count": 9
    },
    {
      "pipelineId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "pipelineName": "Invoice Batch — 2024-09-13",
      "count": 5
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.