Episodes_SummarizeEpisodes

GET

/v1/accounts/{account}/datasets/{dataset}/episodes:summarize

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

Counts, facets and metric distributions over the episodes a filter leaves: what the filter chips, the status bar and the outlier cards read.

Authorizations

• ApiKey

Parameters

Path Parameters

account

required

string

The account id.

dataset

required

string

The dataset id.

Query Parameters

filter

string

Same language as ListEpisodes.filter.

facets

Array<string>

Facet fields to count, e.g. “state”, “open_issue_codes”, “note_codes”, “task”, “tags”, “operator”, “method”, “methods”, “scene”, “rig”, “upload”, “outcome”, “linked_task”, “metrics.quality_tier”, “metrics.jerky”, “viewed”, “decision.actor.kind”. Empty means state only.

metrics

Array<string>

Metric fields to describe, e.g. “metrics.duration_seconds”.

binCount

integer format: int32

Histogram bins per metric; 0 means 30.

Responses

200

OK

Media type application/json

Response for Episodes.SummarizeEpisodes.

object

episodeCount

Episodes the filter leaves.

string

durationSeconds

Their recorded time, seconds.

number format: double

frameCount

Frames.

string

facets

One per requested facet.

Array<object>

One facet: counts per value.

object

field

The facet field.

string

buckets

Buckets, largest first.

Array<object>

One value and how many episodes carry it.

object

value

The value, as the filter spells it.

string

count

Episodes carrying it.

string

otherCount

Distinct values beyond the buckets returned.

string

distributions

One per requested metric.

Array<object>

One metric’s distribution over the filtered episodes.

object

field

The metric field.

string

sampleCount

Episodes with a value.

string

quantiles

P05, p10, p25, p50, p75, p90, p95.

Array<number>

binEdges

Bin edges, bin_count + 1 values.

Array<number>

binCounts

Episodes per bin.

Array<string>

fenceLow

Lower and upper fences the checks use for this metric in this dataset (Q1 - 3 IQR, Q3 + 3 IQR over its robot’s reference); NaN when unfenced.

number format: double

fenceHigh

Upper fence.

number format: double

Example ^generated

{
  "episodeCount": "example",
  "durationSeconds": 1,
  "frameCount": "example",
  "facets": [
    {
      "field": "example",
      "buckets": [
        {
          "value": "example",
          "count": "example"
        }
      ],
      "otherCount": "example"
    }
  ],
  "distributions": [
    {
      "field": "example",
      "sampleCount": "example",
      "quantiles": [
        1
      ],
      "binEdges": [
        1
      ],
      "binCounts": [
        "example"
      ],
      "fenceLow": 1,
      "fenceHigh": 1
    }
  ]
}

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"
    }
  ]
}