Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Query a trace
Queries the environment's traces over a bounded interval, returning summaries without spans.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Queries the environment's traces over a bounded interval, returning summaries without spans.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/traces:query - Scope
observability:read - Effect
read— nothing is written. - Collection traces
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent the method acts in. Required. |
filter | string | AIP-160 filter over the typed, allowlisted fields. |
start_time | timestamp | The interval start; required, at most 31 days before end_time. Required. |
end_time | timestamp | The interval end; default now. |
order_by | string | time desc (default) or time asc. |
page_size | int32 | At most this many; default 100, clamped to 1000. |
page_token | string | next_page_token of the previous page; bound to tenant, interval, filter, and order. |
#Response
| Field | Type | What it is |
|---|---|---|
traces | Trace[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Trace
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/traces/{trace}. |
uid | string | trc_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
trace_id | string | The W3C trace id (32 hex). Output only. |
root_span_name | string | The root span's name. Output only. |
root_service_name | string | The root span's service. Output only. |
start_time | timestamp | The earliest span start. Output only. |
end_time | timestamp | The latest span end. Output only. |
has_error | bool | Whether any span has an error status. Output only. |
spans | Span[] | Every span, in start order; empty in query results. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Span
| Field | Type | What it is |
|---|---|---|
trace_id | string | W3C trace id (32 hex). Required. |
span_id | string | W3C span id (16 hex). Required. |
parent_span_id | string | The parent span id; empty for a root span. |
span_name | string | The operation name. Required. |
service_name | string | The emitting service. Required. |
kind | SpanKind | The span kind. One of internal, server, client, producer, consumer. |
start_time | timestamp | When the span started. Required. |
end_time | timestamp | When the span ended; not before start_time. Required. |
error | bool | Whether the span failed. |
error_message | string | The error message, when error. |
attributes | map<string, string> | Typed attributes, at most 64. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/traces:query" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"start_time":{}}'