API docs by Redocly

OpenBKN Object Metric Query V1 (1.0.0)

Download OpenAPI specification:

Trial and query immutable, version-pinned object metrics.

Inspect process-local EE metric snapshot counters.

Internal service-network endpoint. Contains only aggregate counters, with no identities, queries or result payloads.

Responses

Response samples

Content type
application/json
{
  • "entries": 0,
  • "bytes": 0,
  • "events": {
    }
}

Trial an unpublished object metric against real data without persisting it.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
Request Body schema: application/json
required
required
object

A complete atomic, derived, or composite ObjectMetricDefinitionV1. Non-atomic dependencies must reference published immutable versions.

required
object (ObjectMetricQuery)

Responses

Request samples

Content type
application/json
{
  • "definition": { },
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "is_approximate": true,
  • "model": { },
  • "entries": [
    ],
  • "status": "ok",
  • "empty_reason": "filtered_out",
  • "total_count": 0,
  • "next_cursor": "string",
  • "warnings": [
    ],
  • "overall_ms": 0,
  • "evaluated_at": 0,
  • "effective_window": {
    }
}

Query an immutable published object metric version.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Immutable published metric version. Runtime never resolves an implicit latest version.

Request Body schema: application/json
required
(ObjectMetricScalarPredicate (object) or ObjectMetricMembershipPredicate (object) or ObjectMetricRangePredicate (object) or ObjectMetricUnaryPredicate (object)) or object or object (ObjectMetricCondition)
Array of objects (PropertyRef)

Runtime dimensions selected from the metric definition's query_capabilities.analysis_dimensions. Fixed grain is always applied and cannot be removed.

object

Filters final metric values after the complete atomic, derived, or composite result is computed. Rejected on partial results.

Array of objects

Sorts final rows. Ties are broken by the stable result identity; nulls sort last.

page_size
integer [ 1 .. 1000 ]

Optional. Omit to return all rows. Paginated published queries and trials reuse a bounded process-local snapshot of the final ordered result when available; single-page results are not retained. Default snapshot limits are 10000 rows, 16 MiB per entry, 256 MiB/128 entries per process and 8 entries per caller, with a fixed 15-minute lease.

cursor
string

Authenticated opaque next_cursor from the identical query and caller. Every page rechecks current permissions and row filters. A snapshot hit returns the original calculation even if source data changed. On expiry, eviction, restart, another replica, or changed authorization fingerprint, the service recomputes and compares the complete result hash; a changed result returns 409 and requires restarting from the first page. Snapshot expiry ends reuse, not authenticated hash-checked fallback. A persistent BKN_QUERY_CURSOR_KEY is required across restarts and replicas; Helm supplies a shared release Secret by default. Tampered or mismatched cursors are rejected; revoked access returns 403.

object
object

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "group_by": [
    ],
  • "having": {
    },
  • "order_by": [
    ],
  • "page_size": 1,
  • "cursor": "string",
  • "time": {
    },
  • "bucket_selection": {
    }
}

Response samples

Content type
application/json
{
  • "is_approximate": true,
  • "model": { },
  • "entries": [
    ],
  • "status": "ok",
  • "empty_reason": "filtered_out",
  • "total_count": 0,
  • "next_cursor": "string",
  • "warnings": [
    ],
  • "overall_ms": 0,
  • "evaluated_at": 0,
  • "effective_window": {
    }
}

Page through authorized participants of a published metric result bucket.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string
query Parameters
version
required
integer >= 1
branch
string
Default: "main"
Request Body schema: application/json
required
required
object (ObjectMetricQuery)
bucket_key
required
string
page_size
integer [ 1 .. 100 ]
cursor
string

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "bucket_key": "string",
  • "page_size": 1,
  • "cursor": "string"
}

Response samples

Content type
application/json
{
  • "participants": [
    ],
  • "next_cursor": "string",
  • "bucket_value": null,
  • "evaluated_at": 0,
  • "status": "ok",
  • "warnings": [
    ]
}

Page through authorized participants of a trial result bucket.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
Request Body schema: application/json
required
required
object (ObjectMetricQuery)
bucket_key
required
string
page_size
integer [ 1 .. 100 ]
cursor
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "bucket_key": "string",
  • "page_size": 1,
  • "cursor": "string",
  • "definition": { }
}

Response samples

Content type
application/json
{
  • "participants": [
    ],
  • "next_cursor": "string",
  • "bucket_value": null,
  • "evaluated_at": 0,
  • "status": "ok",
  • "warnings": [
    ]
}