Skip to content
agentex-sdk
API Reference
Spans

List Spans

spans.list(SpanListParams**kwargs) -> SpanListResponse
GET/spans

List spans, optionally filtered by trace_id and/or task_id

ParametersExpand Collapse
limit: Optional[int]
order_by: Optional[str]
order_direction: Optional[str]
page_number: Optional[int]
task_id: Optional[str]
trace_id: Optional[str]
ReturnsExpand Collapse
List[Span]
id: str
name: str

Name that describes what operation this span represents

start_time: datetime

The time the span started

formatdate-time
trace_id: str

Unique identifier for the trace this span belongs to

data: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Any additional metadata or context for the span

One of the following:
Dict[str, object]
List[Dict[str, object]]
end_time: Optional[datetime]

The time the span ended

formatdate-time
input: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Input parameters or data for the operation

One of the following:
Dict[str, object]
List[Dict[str, object]]
output: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Output data resulting from the operation

One of the following:
Dict[str, object]
List[Dict[str, object]]
parent_id: Optional[str]

ID of the parent span if this is a child span in a trace

task_id: Optional[str]

ID of the task this span belongs to

List Spans

import os
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
spans = client.spans.list()
print(spans)
[
  {
    "id": "id",
    "name": "name",
    "start_time": "2019-12-27T18:11:19.117Z",
    "trace_id": "trace_id",
    "data": {
      "foo": "bar"
    },
    "end_time": "2019-12-27T18:11:19.117Z",
    "input": {
      "foo": "bar"
    },
    "output": {
      "foo": "bar"
    },
    "parent_id": "parent_id",
    "task_id": "task_id"
  }
]
Returns Examples
[
  {
    "id": "id",
    "name": "name",
    "start_time": "2019-12-27T18:11:19.117Z",
    "trace_id": "trace_id",
    "data": {
      "foo": "bar"
    },
    "end_time": "2019-12-27T18:11:19.117Z",
    "input": {
      "foo": "bar"
    },
    "output": {
      "foo": "bar"
    },
    "parent_id": "parent_id",
    "task_id": "task_id"
  }
]