Skip to content
Qualia Docs

Issues_SummarizeIssues

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

Counts per code and state over the same set ListIssues returns for the same parent and filter (for a mixture: its own plus upstream issues); dataset = "<parent>" in the filter narrows to the parent’s own scope. The overview’s issues table (QUA-2248) passes dataset = parent for the rows it offers actions on, since only those can be dismissed there.

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.

Query Parameters

Section titled “Query Parameters ”
filter
string

Same language as ListIssues.filter.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Issues.SummarizeIssues.

object
rows

One row per code, most open first.

Array<object>

One row: a code and how often it stands in each state.

object
code

The code; empty groups a person’s own words.

string
kind

Its kind.

string format: enum
Allowed values: KIND_UNSPECIFIED TAKE RECORDING SCENE MOTION GRIPPER CONTROL DISTRIBUTION MIXTURE
title

Its label.

string
authorKind

Who raises it.

string format: enum
Allowed values: KIND_UNSPECIFIED PERSON VALIDATION RULE MODEL OPERATOR SYSTEM
blocks

Whether it blocks (false for notes).

boolean
openCount

Open issues with this code.

string
dismissedCount

Dismissed issues with this code.

string
openEpisodeCount

Distinct episodes with an open one.

string
Example 
{
  "rows": [
    {
      "kind": "KIND_UNSPECIFIED",
      "authorKind": "KIND_UNSPECIFIED"
    }
  ]
}

default

Section titled “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"
    }
  ]
}