Search

cURL

curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "entity_types": [],
  "project_id": "<string>",
  "limit": 20,
  "cursor": "<string>"
}
'

import requests

url = "https://api.staging.qyl.dev/api/v1/search"

payload = {
    "query": "<string>",
    "entity_types": [],
    "project_id": "<string>",
    "limit": 20,
    "cursor": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    entity_types: [],
    project_id: '<string>',
    limit: 20,
    cursor: '<string>'
  })
};

fetch('https://api.staging.qyl.dev/api/v1/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.staging.qyl.dev/api/v1/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([
    'query' => '<string>',
    'entity_types' => [
        
    ],
    'project_id' => '<string>',
    'limit' => 20,
    'cursor' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.staging.qyl.dev/api/v1/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}")

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

	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.staging.qyl.dev/api/v1/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/search")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}"

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

{
  "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>"
  ]
}

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 123,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>",
      "rejected_value": "<string>"
    }
  ],
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

POST

api

cURL

curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "entity_types": [],
  "project_id": "<string>",
  "limit": 20,
  "cursor": "<string>"
}
'

import requests

url = "https://api.staging.qyl.dev/api/v1/search"

payload = {
    "query": "<string>",
    "entity_types": [],
    "project_id": "<string>",
    "limit": 20,
    "cursor": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    entity_types: [],
    project_id: '<string>',
    limit: 20,
    cursor: '<string>'
  })
};

fetch('https://api.staging.qyl.dev/api/v1/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.staging.qyl.dev/api/v1/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([
    'query' => '<string>',
    'entity_types' => [
        
    ],
    'project_id' => '<string>',
    'limit' => 20,
    'cursor' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.staging.qyl.dev/api/v1/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}")

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

	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.staging.qyl.dev/api/v1/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/search")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"entity_types\": [],\n  \"project_id\": \"<string>\",\n  \"limit\": 20,\n  \"cursor\": \"<string>\"\n}"

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

{
  "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>"
  ]
}

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 123,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>",
      "rejected_value": "<string>"
    }
  ],
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<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

Show child attributes

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

Getting Started

Features

API Reference

Alerts

Configurator

Deployments

Errors

Issues

Logs

Metrics

Onboarding

Services

Sessions

Streaming

Traces

Workflows

Workspaces

Health

Search

Body

Response