Query

Query metric data points

POST /api/v1/metrics/query

cURL

cURL

curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/metrics/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "metric_name": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "filters": {},
  "group_by": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "metric_name": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "filters": {},
    "group_by": ["<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({
    metric_name: '<string>',
    start_time: '2023-11-07T05:31:56Z',
    end_time: '2023-11-07T05:31:56Z',
    filters: {},
    group_by: ['<string>']
  })
};

fetch('https://api.staging.qyl.dev/api/v1/metrics/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.staging.qyl.dev/api/v1/metrics/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([
    'metric_name' => '<string>',
    'start_time' => '2023-11-07T05:31:56Z',
    'end_time' => '2023-11-07T05:31:56Z',
    'filters' => [
        
    ],
    'group_by' => [
        '<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/metrics/query"

	payload := strings.NewReader("{\n  \"metric_name\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"filters\": {},\n  \"group_by\": [\n    \"<string>\"\n  ]\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/metrics/query")
  .header("Content-Type", "application/json")
  .body("{\n  \"metric_name\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"filters\": {},\n  \"group_by\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"metric_name\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"filters\": {},\n  \"group_by\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "metric_name": "<string>",
  "series": [
    {
      "labels": {},
      "points": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "value": 123
        }
      ]
    }
  ]
}

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

Metric query request

metric_name · string · required

Metric name

start_time · string<date-time> · required

Start time

end_time · string<date-time> · required

End time

filters · object

Label filters

Show child attributes

step · enum<string>

Step interval

Available options: 1m, 5m, 15m, 1h, 1d, 1w, auto

aggregation · enum<string>

Aggregation function

Available options: sum, avg, min, max, count, last, rate, increase

group_by · string[]

Group by labels

Response

200

application/json

The request has succeeded.

Metric query response

metric_name · string · required

Metric name

series · object[] · required

Time series data

Show child attributes