Skip to content
Qualia Docs

Checks_ListCheckFindings

GET
/v1/accounts/{account}/datasets/{dataset}/checks/{check}/findings
 
curl --request GET \
  --url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/checks/example/findings \
  --header 'X-API-Key: <X-API-Key>'

Lists the findings catalog checks wrote on a dataset, newest first: one per check, episode and finding key per run. The check may be - for every check’s. Findings written before the catalog (templates) are listed under the check their template maps to, with legacy set.

By default only the findings that stand: for each check and episode, those of the newest run of that check (by start) that read the episode at its linked revision, the Task and revision its link carries (Episode.linked_task_revision: its own link’s, else its dataset’s). Publishing a newer revision changes nothing; after a relink an episode has none until a run reads the new revision. A draft link carries no revision, nor does an episode with no link: there a finding stands while its Task is published at the revision it read (a draft’s until the Task is first published), and one whose Task the workspace no longer has has no newer revision. Under any link only the linked Task’s findings stand: a link moved to another Task, published or not, leaves none until a run reads that Task. A finding with no Task has no revision. A heuristic check has no Task revision: its findings are its issues, each as its newest run left it. The filter all_revisions = true lists every run’s findings.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

check
required
string

The check id.

Query Parameters

Section titled “Query Parameters ”
pageSize
integer format: int32

At most this many; 0 means 100, the maximum is 1000.

pageToken
string

From a previous response’s next_page_token.

filter
string

AIP-160 filter. Fields: check_run, episode (names, =), verdict, and all_revisions (true lists superseded runs’ findings too; default false: only the findings that stand). Terms join with AND.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Checks.ListCheckFindings.

object
checkFindings

One page of findings, newest first.

Array<object>

One finding a catalog check wrote on an episode. Its issue identity is the dataset, episode, check id and finding key: a re-run of a check updates only that check’s issues, and a skipped episode leaves them as they were.

Served by qds-api.

object
name

Accounts/{account}/datasets/{dataset}/checks/{check}/findings/{finding}

string
checkRun

Accounts/{account}/checks/vlm/runs/{run}: the run that wrote it.

string
checkVersion

The check version that wrote it; 0 for a legacy finding.

integer format: int32
legacy

Whether it was written by a template before the catalog; its check is the one the template maps to.

boolean
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}

string
findingKey

Stable within the check, e.g. success_1 for a criterion.

string
verdict

What it found.

string format: enum
Allowed values: VERDICT_UNSPECIFIED PASS FAIL UNKNOWN
confidence

0 to 1.

number format: float
severity

What it raised.

string format: enum
Allowed values: SEVERITY_UNSPECIFIED NONE NOTE ISSUE
title

A few words.

string
summary

One sentence.

string
explanation

The evidence, in a few sentences.

string
taskRevision

Accounts/{account}/tasks/{task}/revisions/{revision}: the Task revision it read against, for a Task check; the Task’s name for one read against its unpublished draft; empty otherwise.

string
issue

Accounts/{account}/datasets/{dataset}/issues/{issue}: the issue or note it raised; empty for a pass.

string
createTime

When it was written.

string format: date-time
nextPageToken

Empty on the last page.

string
Example 
{
  "checkFindings": [
    {
      "verdict": "VERDICT_UNSPECIFIED",
      "severity": "SEVERITY_UNSPECIFIED"
    }
  ]
}

default

Section titled “default ”

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
  "code": "example",
  "message": "example",
  "retryable": true,
  "details": [
    {}
  ]
}