Checks_ListCheckFindings

GET

/v1/accounts/{account}/datasets/{dataset}/checks/{check}/findings

curl --request GET \
  --url https://dev-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 (QUA-3408 templates) are listed under the check their template maps to, with legacy set.

Authorizations

• ApiKey

Parameters

Path Parameters

account

required

string

The account id.

dataset

required

string

The dataset id.

check

required

string

The check id.

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.

Responses

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 (QUA-3524). 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 QUA-3408 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

The Task revision it read against, for a Task check; 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

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}