Skip to content
Qualia Docs

Datasets_GetIngestReport

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

The structured report an upload’s ingest wrote (meta/ingest_report.json at the latest publication). NOT_FOUND when the upload has none; FAILED_PRECONDITION on a mixture.

A merged dataset answers its uploads’ reports folded into one (QUA-3694), in the shape of an upload’s: sources are those of its base upload (the first, in merge order, that holds the commonest time sync, named in base), findings are the processing findings of every upload rolled up by what they are about, each with the number of uploads it was found in, sync_agreement says how many uploads hold the base’s time sync and how the others differ, and uploads counts the reports read, absent, unreadable and not yet read. The read is bounded in time: a call that finds uploads unread answers what it has and the next goes further. NOT_FOUND when none of its uploads has a report; UNAVAILABLE (try again) when nothing can be folded yet because an upload is still unread or a read of a report failed in a way a retry may mend.

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.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

The structured report an upload’s ingest wrote: per recording, its topics, episodes and findings, and the upload’s report card. A merged dataset has its uploads’ folded into one (Datasets.GetIngestReport).

object
name

Accounts/{account}/datasets/{dataset}/ingestReport

string
sizeBytes

Size of the stored report in bytes.

string
report

The report as written (version, generated_at, sources, validation); unset when omission is set.

object
omission

Why report is unset. A caller shows an omitted report as unreadable, never as clean.

string format: enum
Allowed values: OMISSION_UNSPECIFIED TOO_LARGE UNPARSEABLE
Example 
{
  "omission": "OMISSION_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"
    }
  ]
}