> ## Documentation Index > Fetch the complete documentation index at: https://docs.privue.ai/llms.txt > Use this file to discover all available pages before exploring further. # Count your gated runs > Count the runs a check of yours stopped, in total, per workflow and per gate that stopped them. Every time one of your gate-check steps stopped a journey is counted once, whether your system answered `terminate` or `redirect` or gave no answer and the workflow fell back to `terminate`, and however the verification has moved on since. A verification you reset after its gate stopped it is still counted for that run, and one stopped again on the run the reset began is counted again, each run being a run of its own. A gated verification that has since expired or been purged is counted too. Narrow it to a period with `from` and `to`. Those are read against the day the gate stopped each run, so a period counts the stops made in it, whenever the verification behind one was created. This differs from `gated` in the verification summary, which counts the verifications standing in that status now, by the day each was created. ## OpenAPI ````yaml /verification/api-reference/openapi.json get /verifications/gated-runs openapi: 3.1.0 info: title: Verify with Privue description: >- Start identity-and-business verifications and read the results. There are three ways to run one, and a verification reads the same whichever it was. Every workflow declares which it is for as its `mode`, and a workflow is one of them and never more. **Hosted.** You create a verification with the user's mobile number and receive a journey URL to hand to them. They work through the steps your workflow configures, on our screens, and submit. Use this when the person being verified is reachable and holds their own documents. **Staged.** You create a verification, upload each document you hold against the step it answers, and ask for the checks to run. They take longer than a request should be held open, so you read the result from a callback or by polling. Use this when documents reach you over time, or when you want them kept on the record to download later. **Instant.** You send the whole submission in one request. The checks run before it answers, so the reply is the finished record. The documents are read as they arrive and stored nowhere. Use this when you hold everything already and want the answer in the call you made. Whichever it was, you read the whole record: every step, its state, what it collected, and why anything did not pass. An instant verification hands you that record in its reply; for the other two, poll the verification or register a callback endpoint and be told when it is submitted. Across your whole account you can list the workflows configured for you, count your verifications by status, and page through the records behind a count. Every error response has the shape `{"code": "...", "detail": "..."}`. Branch on `code`: several causes share a status, and `detail` is written for a person reading a log rather than for code. Treat a code you do not recognise as the status it arrived at. version: 0.1.0 servers: - url: https://api.verify.privue.ai description: Production security: [] tags: - name: Workflows description: >- The workflows configured for your account. Read one to see its mode, the documents it asks for, and how each step is answered over the API: the slots its documents go in and the values it takes. - name: Verifications description: >- Starting a verification, ending one, clearing one to run the same subject again, and purging one. Shared by both modes. A start answers 201 when it created the verification and 200 when the subject already had one, so a duplicate is visible from the status code alone. - name: Hosted workflows description: >- For a workflow the person being verified walks themselves. Start a verification with their mobile number, hand them the journey URL on the record, or open it for them from inside your own app with a handoff. - name: Staged workflows description: >- For a workflow you build up from documents you already hold. Upload each file against the step and slot it answers, withdraw one you got wrong, then ask for the checks to run and read the result when they have. Nobody is sent anywhere. - name: Instant workflows description: >- For a workflow answered in the request that asks it. Send the whole submission at once and read the finished record in the reply. Nothing is kept of the documents and nothing is left open to come back to. - name: Results description: >- Reading what a verification came to: one record, a page of them, counts across your account, and links to the files it holds. paths: /verifications/gated-runs: get: tags: - Results summary: Count your gated runs description: >- Count the runs a check of yours stopped, in total, per workflow and per gate that stopped them. Every time one of your gate-check steps stopped a journey is counted once, whether your system answered `terminate` or `redirect` or gave no answer and the workflow fell back to `terminate`, and however the verification has moved on since. A verification you reset after its gate stopped it is still counted for that run, and one stopped again on the run the reset began is counted again, each run being a run of its own. A gated verification that has since expired or been purged is counted too. Narrow it to a period with `from` and `to`. Those are read against the day the gate stopped each run, so a period counts the stops made in it, whenever the verification behind one was created. This differs from `gated` in the verification summary, which counts the verifications standing in that status now, by the day each was created. operationId: read_gated_run_counts_verifications_gated_runs_get parameters: - name: from in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: First day to include, in IST, inclusive. title: From description: First day to include, in IST, inclusive. - name: to in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Last day to include, in IST, inclusive. title: To description: Last day to include, in IST, inclusive. responses: '200': description: The runs your checks stopped, in total, per workflow and per gate. content: application/json: schema: $ref: '#/components/schemas/GatedRunsSummary' example: total: 8 workflows: - workflow_key: merchant-onboarding total: 6 gates: - step_key: already-a-dealer stopped: 4 - step_key: gst-onboarded stopped: 2 - workflow_key: vendor-verification total: 2 gates: - step_key: gst-onboarded stopped: 2 '401': description: |- The API key is missing, malformed, or revoked. The code is `unauthenticated`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: unauthenticated detail: Missing or malformed Authorization header '403': description: >- The API key is valid but not enrolled for verifications, or is not set up for exactly one of `uat` and `production`. Ask us to reissue it. The code is `client-not-enrolled`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: client-not-enrolled detail: >- no active verification client 4b8f21c6-59ad-4a70-9e11-7c3d0a52f8b4 '422': description: |- The period asked for runs backwards. The code is `window-invalid`. content: application/json: example: code: window-invalid detail: 'from: must not be after to' schema: $ref: '#/components/schemas/ErrorResponse' '429': description: |- The API key is rate limited. Retry after a pause. The code is `rate-limited`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: rate-limited detail: 'Unauthorized: RATE_LIMITED' '503': description: |- API keys could not be checked right now. Retry. The code is `auth-unavailable`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: auth-unavailable detail: Auth provider unavailable security: - HTTPBearer: [] components: schemas: GatedRunsSummary: properties: total: type: integer title: Total description: >- Runs stopped across all your workflows, which is the sum of `workflows`. workflows: items: $ref: '#/components/schemas/WorkflowGatedRuns' type: array title: Workflows description: >- The same runs counted per workflow, ordered by key. A workflow appears once one of its gates has stopped a run in what was counted, so a workflow whose gates stopped nothing is absent. type: object required: - total - workflows title: GatedRunsSummary description: How many runs a check of yours stopped, in total and per workflow. ErrorResponse: properties: code: $ref: '#/components/schemas/ErrorCode' description: >- What went wrong. Branch on this rather than on the status code, which several causes share, and never on `detail`. Treat a code you do not recognise as the status it arrived at: codes are added as new causes become reachable, and an existing one never changes meaning. detail: type: string title: Detail description: >- What went wrong, in words, naming the workflow, verification, step or field at fault where one is. Written for a person reading a log rather than for code to read, so it is not stable and nothing should be matched against it. type: object required: - code - detail title: ErrorResponse description: The envelope every failure is answered in. WorkflowGatedRuns: properties: workflow_key: type: string title: Workflow Key description: The workflow the counts belong to. total: type: integer title: Total description: Runs this workflow's gates stopped, which is the sum of `gates`. gates: items: $ref: '#/components/schemas/GateCount' type: array title: Gates description: >- Each gate that stopped a run, the one that stopped the most first and ties ordered by step key. A gate that stopped nothing in what was counted is absent. type: object required: - workflow_key - total - gates title: WorkflowGatedRuns description: One workflow's gated runs, counted by the gate that stopped each one. ErrorCode: type: string enum: - unauthenticated - client-not-enrolled - rate-limited - auth-unavailable - environment-mismatch - request-invalid - body-unreadable - page-cursor-invalid - window-invalid - request-too-large - not-found - method-not-allowed - internal-error - workflow-not-found - workflow-version-not-found - workflow-not-runnable - workflow-not-walkable - workflow-misconfigured - context-incomplete - context-value-invalid - mobile-required - journey-fields-refused - return-url-not-allowed - reference-taken - verification-not-found - verification-not-open - verification-expired - run-in-progress - credits-exhausted - resets-exhausted - live-limit-reached - step-not-found - step-not-ready - step-invalid - document-not-found - document-not-stored - document-too-large - document-type-not-allowed title: ErrorCode description: >- What went wrong, as a value to branch on. Published vocabulary, stated here rather than shared with any other product of ours: these are read by integrations we do not control, so a name here means what it says for as long as the endpoint answering it exists. One code names one cause, so a status carrying several causes is told apart by the code and never by the message. Codes are added as new causes become reachable; an integration therefore treats an unrecognised code as the status it arrived at. GateCount: properties: step_key: type: string title: Step Key description: The gate-check step that stopped them, as the workflow declares it. stopped: type: integer title: Stopped description: How many runs it stopped. type: object required: - step_key - stopped title: GateCount description: How many runs one of a workflow's gates stopped. securitySchemes: HTTPBearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.