Skip to main content
POST
/
api
/
svc
/
v1
/
spans
/
query
Get filtered spans data with detailed attributes
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/spans/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "startTime": "<string>",
  "endTime": "<string>",
  "traceIds": [
    "traceid1",
    "traceid2"
  ],
  "spanIds": [
    "spanId1",
    "spanId2"
  ],
  "parentSpanIds": [
    "",
    "parentSpanId1",
    "parentSpanId2"
  ],
  "createdBySubjectTypes": [
    "user",
    "virtualaccount"
  ],
  "createdBySubjectSlugs": [
    "user@example.com",
    "service-account"
  ],
  "applicationNames": [
    "tfy-llm-gateway",
    "order-service"
  ],
  "limit": 200,
  "sortDirection": "desc",
  "pageToken": "<string>",
  "tracingProjectFqn": "<string>",
  "filters": [
    {
      "spanFieldName": "spanName",
      "operator": "EQUAL",
      "value": "<string>"
    }
  ]
}'
{
  "data": [
    {
      "spanId": "<string>",
      "traceId": "<string>",
      "parentSpanId": "<string>",
      "serviceName": "<string>",
      "spanName": "<string>",
      "spanKind": "<string>",
      "scopeName": "<string>",
      "scopeVersion": "<string>",
      "timestamp": "<string>",
      "durationNs": 123,
      "statusCode": "<string>",
      "statusMessage": "<string>",
      "spanAttributes": {},
      "events": [
        {}
      ],
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
startTime
string
required

Start time in ISO 8601 format (e.g., 2025-03-12T00:00:09.872Z)

​
tracingProjectFqn
string
required

Tracing project FQN (e.g., truefoundry:tracing-project:tfy-default)

​
endTime
string

End time in ISO 8601 format (e.g., 2025-03-12T00:10:00.000Z). Defaults to current time if not provided.

​
traceIds
string[]

Array of trace IDs to filter by

Example:
["traceid1", "traceid2"]
​
spanIds
string[]

Array of span IDs to filter by

Example:
["spanId1", "spanId2"]
​
parentSpanIds
string[]

Array of parent span IDs to filter by

Example:
["", "parentSpanId1", "parentSpanId2"]
​
createdBySubjectTypes
enum<string>[]

Array of subject types to filter by

Example:
["user", "virtualaccount"]
​
createdBySubjectSlugs
string[]

Array of subject slugs to filter by

Example:
["user@example.com", "service-account"]
​
applicationNames
string[]

Array of application names to filter by

Example:
["tfy-llm-gateway", "order-service"]
​
limit
integer

The maximum number of spans to return per page. Defaults to 200 if not provided.

Example:

200

​
sortDirection
enum<string>

Sort direction for results based on time. Defaults to descending (latest first)

Available options:
asc,
desc
Example:

"desc"

​
pageToken
string

An opaque string that should be passed as-is from previous response for fetching the next page. Pass $response.pagination.nextPageToken from previous response for fetching the next page.

​
filters
(SpanFieldFilter · object | SpanAttributeFilter · object | GatewayRequestMetadataFilter · object)[]

Array of filters

  • SpanFieldFilter
  • SpanAttributeFilter
  • GatewayRequestMetadataFilter

Response

200 - application/json

Returns all the spans matching the query.

​
data
TraceSpan · object[]
required

Array of flat spans

​
pagination
object
required

Pagination information