Skip to main content
POST
/
v3
/
spans
/
query
Query spans
curl --request POST \
  --url https://api.example.com/v3/spans/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "ordering": "-start_time",
  "page_size": 50,
  "offset": 0
}
'
import requests

url = "https://api.example.com/v3/spans/query"

payload = {
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"ordering": "-start_time",
"page_size": 50,
"offset": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
ordering: '-start_time',
page_size: 50,
offset: 0
})
};

fetch('https://api.example.com/v3/spans/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v3/spans/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'ordering' => '-start_time',
'page_size' => 50,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v3/spans/query"

payload := strings.NewReader("{\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"ordering\": \"-start_time\",\n \"page_size\": 50,\n \"offset\": 0\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v3/spans/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"ordering\": \"-start_time\",\n \"page_size\": 50,\n \"offset\": 0\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/spans/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"ordering\": \"-start_time\",\n \"page_size\": 50,\n \"offset\": 0\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "page_size": 10,
    "item_count": 10,
    "total": 100,
    "page_count": 10,
    "page_index": 1,
    "offset": 0,
    "items": [
      {
        "span_id": "<string>",
        "trace_id": "<string>",
        "name": "<string>",
        "status_code": "<string>",
        "start_time": "2023-11-07T05:31:56Z",
        "duration": 123,
        "parent_span_id": "<string>",
        "session_id": "<string>",
        "span_type": "<string>",
        "status_message": "<string>",
        "agent_id": "<string>",
        "agent_name": "<string>",
        "input": "<string>",
        "output": "<string>",
        "span_attributes": {},
        "evaluators": [
          {
            "evaluator_rule_name": "<string>",
            "output_name": "<string>",
            "value": 123,
            "label": "<string>"
          }
        ],
        "resource_attributes": {},
        "service_name": "<string>",
        "span_kind": "<string>",
        "events": [
          {
            "timestamp": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "attributes": {}
          }
        ],
        "links": [
          {
            "trace_id": "<string>",
            "span_id": "<string>",
            "trace_state": "<string>",
            "attributes": {}
          }
        ],
        "semantic_mapping": {}
      }
    ]
  }
}
{
"api_version": "3.0",
"kind": "ERROR",
"error": {
"code": 400,
"message": "Resource Not Found",
"errors": [
{
"reason": "ResourceNotFoundException",
"message": "Resource Not Found",
"help": "<string>"
}
]
}
}
{
"api_version": "3.0",
"kind": "ERROR",
"error": {
"code": 400,
"message": "Resource Not Found",
"errors": [
{
"reason": "ResourceNotFoundException",
"message": "Resource Not Found",
"help": "<string>"
}
]
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
application_id
string<uuid>
required
start_time
string<date-time>
required

Start of the time range (inclusive, UTC).

end_time
string<date-time>
required

End of the time range (exclusive, UTC).

filter
object

Optional structured filter tree. Maximum nesting depth is 3 levels and maximum total rule count is 10.

ordering
string
default:-start_time

Sort field with optional leading "-" for descending

page_size
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: 0 <= x <= 10000

Response

A paginated list of spans matching the query

Response object for paginated API responses.

api_version
enum<string>
default:3.0

API version of the response.

Available options:
2.0,
3.0
kind
enum<string>
default:PAGINATED

Type of response, indicating a paginated response.

Available options:
PAGINATED
data
object