Skip to main content
GET
Customer-facing ingestion pipeline health (TRU-167)

Authorizations

Authorization
string
header
required

SDK API key (tl_...) or Clerk session JWT

Query Parameters

project_id
string<uuid>

Filter to a single project. Omit for all projects in the tenant.

window
enum<string>
default:24h

Rolling time window. Defaults to 24h. Ignored when both from and to are supplied (TRU-393).

Available options:
1h,
24h,
7d
from
string<date-time>

Inclusive ISO-8601 / RFC 3339 lower bound on the report window. Must be supplied together with to. When both are present the explicit range overrides the window enum (TRU-393). Bucket granularity in the response scales with the requested span: ≤ 2h → 5m, ≤ 48h → 1h, > 48h → 1d.

to
string<date-time>

Inclusive ISO-8601 / RFC 3339 upper bound on the report window. Must be supplied together with from. to must not precede from.

Response

Ingestion-health report

window
enum<string>
required

Echoes the window query param. Informational only when an explicit from/to pair was supplied — the response's from/to fields are the source of truth for the time bounds actually used.

Available options:
1h,
24h,
7d
from
string<date-time>
required

Inclusive lower bound the report was computed over (TRU-393).

to
string<date-time>
required

Inclusive upper bound the report was computed over (TRU-393).

bucket_interval
enum<string>
required

Bucket granularity that scales with the report's requested range: ≤ 2h → 5m, ≤ 48h → 1h, > 48h → 1d (TRU-393). Frontends that build time-series charts on top of this endpoint should consume this value rather than re-deriving it.

Available options:
5m,
1h,
1d
success_rate
number
required

Fraction 0–1 of traces without an error. 1.0 when no traffic in the window.

error_rate
number
required

Fraction 0–1 of traces with a non-empty error.

top_errors
object[]
required
dlq_depth
object
required
ingest_lag_ms
object
required
redaction_match_count
integer<int64>
required

Zero until redaction instrumentation lands.

project_id
string<uuid> | null

Echoes the project_id query param when set; omitted for tenant-wide reports.

last_successful_span_at
string<date-time> | null