Skip to content

List Spans

GET/spans

List spans, optionally filtered by trace_id and/or task_id

Query ParametersExpand Collapse
limit: optional number
order_by: optional string
order_direction: optional string
page_number: optional number
task_id: optional string
trace_id: optional string
ReturnsExpand Collapse
id: string
name: string

Name that describes what operation this span represents

start_time: string

The time the span started

formatdate-time
trace_id: string

Unique identifier for the trace this span belongs to

data: optional map[unknown] or array of map[unknown]

Any additional metadata or context for the span

One of the following:
map[unknown]
array of map[unknown]
end_time: optional string

The time the span ended

formatdate-time
input: optional map[unknown] or array of map[unknown]

Input parameters or data for the operation

One of the following:
map[unknown]
array of map[unknown]
output: optional map[unknown] or array of map[unknown]

Output data resulting from the operation

One of the following:
map[unknown]
array of map[unknown]
parent_id: optional string

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

task_id: optional string

ID of the task this span belongs to

List Spans

curl http://localhost:5003/spans \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
[
  {
    "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"
  }
]