Get session

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/sessions/{sessionId}

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/sessions/{sessionId}', 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/sessions/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/sessions/{sessionId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/sessions/{sessionId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "session.id": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "trace_count": 1,
  "span_count": 1,
  "error_count": 1,
  "services": [
    "<string>"
  ],
  "state": "active",
  "user.id": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "duration_ms": 1,
  "client": {
    "ip": "<string>",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "device_type": "desktop",
    "os": "<string>",
    "browser": "<string>",
    "browser_version": "<string>"
  },
  "geo": {
    "country_code": "<string>",
    "country_name": "<string>",
    "region": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "timezone": "<string>"
  },
  "genai_usage": {
    "request_count": 1,
    "total_input_tokens": 1,
    "total_output_tokens": 1,
    "models_used": [
      "<string>"
    ],
    "providers_used": [
      "<string>"
    ],
    "estimated_cost_usd": 123
  }
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

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

GET

api

sessions

{sessionId}

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/sessions/{sessionId}

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/sessions/{sessionId}', 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/sessions/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/sessions/{sessionId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/sessions/{sessionId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "session.id": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "trace_count": 1,
  "span_count": 1,
  "error_count": 1,
  "services": [
    "<string>"
  ],
  "state": "active",
  "user.id": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "duration_ms": 1,
  "client": {
    "ip": "<string>",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "device_type": "desktop",
    "os": "<string>",
    "browser": "<string>",
    "browser_version": "<string>"
  },
  "geo": {
    "country_code": "<string>",
    "country_name": "<string>",
    "region": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "timezone": "<string>"
  },
  "genai_usage": {
    "request_count": 1,
    "total_input_tokens": 1,
    "total_output_tokens": 1,
    "models_used": [
      "<string>"
    ],
    "providers_used": [
      "<string>"
    ],
    "estimated_cost_usd": 123
  }
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

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

Path Parameters

sessionId

string

required

Response

The request has succeeded.

Complete session entity with aggregated data

session.id

string

required

Session ID

Required string length: 1 - 128

start_time

string<date-time>

required

Session start time

trace_count

integer<int32>

required

Total trace count in session

Required range: x >= 0

span_count

integer<int32>

required

Total span count in session

Required range: x >= 0

error_count

integer<int32>

required

Total error count in session

Required range: x >= 0

services

string[]

required

Service names observed in this session

state

enum<string>

required

Session state

Available options:

active,

idle,

ended,

timed_out,

invalidated

user.id

string

User ID (if authenticated)

Required string length: 1 - 256

end_time

string<date-time>

Session end time

duration_ms

number<double>

Session duration in milliseconds

Required range: x >= 0

client

object

Client information

Show child attributes

geo

object

Location information

Show child attributes

genai_usage

object

GenAI usage summary

Show child attributes

Getting Started

Features

API Reference

Alerts

Configurator

Deployments

Errors

Issues

Logs

Metrics

Onboarding

Search

Services

Sessions

Streaming

Traces

Workflows

Workspaces

Health

Path Parameters

Response