Query Spans

POST /v2/projects/{project_id}/spans/search

Query Spans

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/spans/search \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "starting_token": 0,
  "limit": 100,
  "previous_last_row_id": "<string>",
  "log_stream_id": "<string>",
  "experiment_id": "<string>",
  "metrics_testing_id": "<string>",
  "filters": [
    {
      "column_id": "<string>",
      "value": "<string>",
      "operator": "eq",
      "type": "id"
    }
  ],
  "filter_tree": {
    "filter": {
      "column_id": "<string>",
      "value": "<string>",
      "operator": "eq",
      "type": "id"
    }
  },
  "sort": {
    "column_id": "<string>",
    "ascending": true,
    "sort_type": "column"
  },
  "truncate_fields": false,
  "include_counts": false,
  "include_code_metric_metadata": false
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/spans/search"

payload = {
    "starting_token": 0,
    "limit": 100,
    "previous_last_row_id": "<string>",
    "log_stream_id": "<string>",
    "experiment_id": "<string>",
    "metrics_testing_id": "<string>",
    "filters": [
        {
            "column_id": "<string>",
            "value": "<string>",
            "operator": "eq",
            "type": "id"
        }
    ],
    "filter_tree": { "filter": {
            "column_id": "<string>",
            "value": "<string>",
            "operator": "eq",
            "type": "id"
        } },
    "sort": {
        "column_id": "<string>",
        "ascending": True,
        "sort_type": "column"
    },
    "truncate_fields": False,
    "include_counts": False,
    "include_code_metric_metadata": False
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    starting_token: 0,
    limit: 100,
    previous_last_row_id: '<string>',
    log_stream_id: '<string>',
    experiment_id: '<string>',
    metrics_testing_id: '<string>',
    filters: [{column_id: '<string>', value: '<string>', operator: 'eq', type: 'id'}],
    filter_tree: {filter: {column_id: '<string>', value: '<string>', operator: 'eq', type: 'id'}},
    sort: {column_id: '<string>', ascending: true, sort_type: 'column'},
    truncate_fields: false,
    include_counts: false,
    include_code_metric_metadata: false
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/spans/search', 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.galileo.ai/v2/projects/{project_id}/spans/search",
  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([
    'starting_token' => 0,
    'limit' => 100,
    'previous_last_row_id' => '<string>',
    'log_stream_id' => '<string>',
    'experiment_id' => '<string>',
    'metrics_testing_id' => '<string>',
    'filters' => [
        [
                'column_id' => '<string>',
                'value' => '<string>',
                'operator' => 'eq',
                'type' => 'id'
        ]
    ],
    'filter_tree' => [
        'filter' => [
                'column_id' => '<string>',
                'value' => '<string>',
                'operator' => 'eq',
                'type' => 'id'
        ]
    ],
    'sort' => [
        'column_id' => '<string>',
        'ascending' => true,
        'sort_type' => 'column'
    ],
    'truncate_fields' => false,
    'include_counts' => false,
    'include_code_metric_metadata' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-API-Key: <api-key>"
  ],
]);

$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.galileo.ai/v2/projects/{project_id}/spans/search"

	payload := strings.NewReader("{\n  \"starting_token\": 0,\n  \"limit\": 100,\n  \"previous_last_row_id\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filters\": [\n    {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  ],\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"sort\": {\n    \"column_id\": \"<string>\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  },\n  \"truncate_fields\": false,\n  \"include_counts\": false,\n  \"include_code_metric_metadata\": false\n}")

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

	req.Header.Add("Galileo-API-Key", "<api-key>")
	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.galileo.ai/v2/projects/{project_id}/spans/search")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"starting_token\": 0,\n  \"limit\": 100,\n  \"previous_last_row_id\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filters\": [\n    {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  ],\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"sort\": {\n    \"column_id\": \"<string>\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  },\n  \"truncate_fields\": false,\n  \"include_counts\": false,\n  \"include_code_metric_metadata\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/spans/search")

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

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"starting_token\": 0,\n  \"limit\": 100,\n  \"previous_last_row_id\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filters\": [\n    {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  ],\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"sort\": {\n    \"column_id\": \"<string>\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  },\n  \"truncate_fields\": false,\n  \"include_counts\": false,\n  \"include_code_metric_metadata\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "num_records": 123,
  "starting_token": 0,
  "limit": 100,
  "paginated": false,
  "next_starting_token": 123,
  "last_row_id": "<string>",
  "records": [
    {
      "id": "<string>",
      "session_id": "<string>",
      "trace_id": "<string>",
      "project_id": "<string>",
      "run_id": "<string>",
      "type": "trace",
      "input": "",
      "redacted_input": "<string>",
      "output": "<string>",
      "redacted_output": "<string>",
      "name": "",
      "created_at": "2023-11-07T05:31:56Z",
      "user_metadata": {},
      "tags": [
        "<string>"
      ],
      "status_code": 123,
      "metrics": {
        "duration_ns": 123
      },
      "external_id": "<string>",
      "dataset_input": "<string>",
      "dataset_output": "<string>",
      "dataset_metadata": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "has_children": true,
      "metrics_batch_id": "<string>",
      "session_batch_id": "<string>",
      "feedback_rating_info": {},
      "annotations": {},
      "file_ids": [
        "<string>"
      ],
      "file_modalities": [],
      "annotation_aggregates": {},
      "annotation_agreement": {},
      "overall_annotation_agreement": 123,
      "annotation_queue_ids": [
        "<string>"
      ],
      "fully_annotated": true,
      "progress_message": "",
      "error_message": "",
      "metric_info": {},
      "files": {},
      "is_complete": true,
      "num_spans": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

project_id · string<uuid4> · required

Body

application/json

starting_token · integer · default: 0

limit · integer · default: 100

previous_last_row_id · string<uuid4> | null

log_stream_id · string<uuid4> | null

Log stream id associated with the traces.

experiment_id · string<uuid4> | null

Experiment id associated with the traces.

metrics_testing_id · string<uuid4> | null

Metrics testing id associated with the traces.

filters · (LogRecordsIDFilter · object | LogRecordsDateFilter · object | LogRecordsNumberFilter · object | LogRecordsBooleanFilter · object | LogRecordsCollectionFilter · object | LogRecordsTextFilter · object | LogRecordsFullyAnnotatedFilter · object)[]

LogRecordsIDFilter

LogRecordsDateFilter

LogRecordsNumberFilter

LogRecordsBooleanFilter

LogRecordsCollectionFilter

LogRecordsTextFilter

LogRecordsFullyAnnotatedFilter

Show child attributes

filter_tree · FilterLeaf[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] · object

FilterLeaf[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

AndNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

OrNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

NotNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

Show child attributes

sort · LogRecordsSortClause · object | null

Sort for the query. Defaults to native sort (created_at, id descending).

Show child attributes

truncate_fields · boolean · default: false

include_counts · boolean · default: false

If True, include computed child counts (e.g., num_traces for sessions, num_spans for traces).

include_code_metric_metadata · boolean · default: false

If True, include per-row scorer metadata (the dict returned alongside the score by code-based scorers via the (score, metadata) tuple-return contract) on each MetricSuccess in the response. Off by default to keep payloads small for callers that don't need it.

Response

200

application/json

Successful Response

num_records · integer · required · read-only

number of records

starting_token · integer · default: 0

limit · integer · default: 100

paginated · boolean · default: false

next_starting_token · integer | null

last_row_id · string<uuid4> | null

records · (ExtendedTraceRecord · object | ExtendedAgentSpanRecord · object | ExtendedWorkflowSpanRecord · object | ExtendedLlmSpanRecord · object | ExtendedToolSpanRecord · object | ExtendedRetrieverSpanRecord · object | ExtendedControlSpanRecord · object | ExtendedSessionRecord · object)[]

records matching the query

ExtendedTraceRecord

ExtendedAgentSpanRecord

ExtendedWorkflowSpanRecord

ExtendedLlmSpanRecord

ExtendedToolSpanRecord

ExtendedRetrieverSpanRecord

ExtendedControlSpanRecord

ExtendedSessionRecord

Show child attributes