Skip to main content
POST
/
api
/
v1
/
search
cURL
curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "entity_types": [
    "span"
  ],
  "project_id": "<string>",
  "limit": 20,
  "cursor": "<string>"
}
'
{
  "results": [
    {
      "document_id": "<string>",
      "entity_type": "span",
      "entity_id": "<string>",
      "title": "<string>",
      "score": 123,
      "snippet": "<string>",
      "url": "<string>"
    }
  ],
  "total_count": 123,
  "duration_ms": 123,
  "next_cursor": "<string>",
  "suggestions": [
    "<string>"
  ]
}

Body

application/json

Unified search request

​
query
string
required

Search query text

​
entity_types
enum<string>[]

Entity type filters

Searchable entity types

Available options:
span,
log,
issue,
workflow,
deployment,
session,
alert,
fix
​
project_id
string

Project scope

​
limit
integer<int32>
default:20

Maximum results

Required range: 1 <= x <= 100
​
cursor
string

Cursor for pagination

Response

The request has succeeded.

Unified search response

​
results
object[]
required

Search results

​
total_count
integer<int64>
required

Total matching documents

​
duration_ms
integer<int32>
required

Query execution time in ms

​
next_cursor
string

Next page cursor

​
suggestions
string[]

Search suggestions