Get Trace

GET

/observability/v1/workspaces/{workspace}/engines/{engine}/traces/{id}

curl --request GET \
  --url https://example.com/observability/v1/workspaces/example/engines/example/traces/example

Retrieves a single full trace (all spans) by id.

Parameters

Path Parameters

workspace

required

string

The workspace whose telemetry is queried.

engine

required

string

The provider: qibdo, aws, gcp, or azure.

id

required

string

The trace id to retrieve — a hexadecimal trace identifier of up to 128 characters.

Responses

200

OK

Media type application/json

GetTraceResponse

Response for GetTrace.

object

trace

The full trace.

object

trace_id

The trace id.

string

spans

The spans that make up the trace.

Array<object>

TraceSpan

A single span within a trace.

object

span_id

The span id.

string

parent_span_id

The parent span id; empty for the root span.

string

service_name

The service that produced the span.

string

operation_name

The operation the span represents.

string

start_time

When the span started.

string format: date-time

duration

How long the span took.

string

/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/

engine

The provider that served the query.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

Example

{
  "engine": "ENGINE_UNSPECIFIED"
}

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