Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.

assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.

evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.

webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.

settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.

groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.

members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.

A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.

Body

application/json

Count every retained matching attempt in [from,to). Capture is best effort; missing attempts cannot be inferred. UTC buckets may be partial at the edges. The window is at most 30 days.

from
string<date-time>
required
to
string<date-time>
required
bucket
enum<string>
default:hour
Available options:
hour,
day
status
integer
Required range: 100 <= x <= 599
endpoint_id
string

Opaque id of the endpoint registration.

Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Response

Retained attempt counts and latency; best-effort capture and explicit queue semantics.

One repeatable-read snapshot of retained request diagnostics or webhook attempts. Capture can have gaps and these counts are not a billing ledger. Unattributed keys include older requests and member requests. Queue state is current retained work, not a delivery success denominator.

schema_version
any
required
source
enum<string>
required
Available options:
requests,
webhook_attempts
from
string<date-time>
required
to
string<date-time>
required
as_of
string<date-time>
required
retained_from
string<date-time>
required
retention_days
integer
required
Required range: 1 <= x <= 30
bucket
enum<string>
required
Available options:
hour,
day
capture
any
required
population
any
required
totals
object
required
buckets
object[]
required

Nonempty UTC buckets in ascending order. Counts include all retained matching attempts, without the log page limit.

Maximum array length: 721
queue
object

Current retained delivery queue, independent of the requested attempt window and status filter. Endpoint filter applies. Does not prove customer enforcement execution.