Get Agent Spans

Returns spans that trace an Agent's execution.

Path Parameters

agentId string required

The ID of the agent to get spans for.

Query Parameters

startTimestamp int32

The earliest timestamp (as seconds since the epoch) to query.

Defaults to 15 minutes before the current time.

endTimestamp int32

The latest timestamp (as seconds since the epoch) to query.

Defaults to the current time.

limit uint32

The maximum number of spans to return.

Defaults to 100. Cannot be more than 1000.

offset uint32

The offset of the first span to return.

conversationId string

The ID of the conversation to get spans for.

messageId string

The ID of the message to get spans for.

status enum

Possible values: [STATUS_CODE_UNSET, STATUS_CODE_OK, STATUS_CODE_ERROR]

The status code of spans to return.

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

spans object[]
Array [
timestamp date-time
The timestamp at which the span started.
traceId string
The trace ID of the span.
spanId string
The span ID of the span.
parentSpanId string
The parent span ID of the span.
durationMs float
The duration of the span in milliseconds.
name string
The name of the span.
kind enum
Possible values: [SPAN_KIND_INTERNAL, SPAN_KIND_SERVER, SPAN_KIND_CLIENT, SPAN_KIND_PRODUCER, SPAN_KIND_CONSUMER]
The kind of the span.
statusCode enum
Possible values: [STATUS_CODE_UNSET, STATUS_CODE_OK, STATUS_CODE_ERROR]
The status code of the span.
statusMessage string
The status message of the span.
attributes object
Additional attributes set on the span.
]

{
  "spans": [
    {
      "timestamp": "2024-03-07T22:56:08.362Z",
      "traceId": "string",
      "spanId": "string",
      "parentSpanId": "string",
      "durationMs": 0,
      "name": "string",
      "kind": "SPAN_KIND_INTERNAL",
      "statusCode": "STATUS_CODE_UNSET",
      "statusMessage": "string",
      "attributes": {}
    }
  ]
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

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.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...