Skip to main content
GET
/
api
/
v1
/
sessions
Error
A valid request URL is required to generate request examples
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "extra": {},
    "name": "<string>",
    "description": "<string>",
    "default_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_count": 123,
    "latency_p50": 123,
    "latency_p99": 123,
    "first_token_p50": 123,
    "first_token_p99": 123,
    "total_tokens": 123,
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_cost": "<string>",
    "prompt_cost": "<string>",
    "completion_cost": "<string>",
    "last_run_start_time": "2023-11-07T05:31:56Z",
    "last_run_start_time_live": "2023-11-07T05:31:56Z",
    "feedback_stats": {},
    "session_feedback_stats": {},
    "run_facets": [
      {}
    ],
    "error_rate": 123,
    "streaming_rate": 123,
    "test_run_number": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Headers

​
accept
string | null

Query Parameters

​
reference_free
boolean | null
​
reference_dataset
string<uuid>[] | null
​
id
string<uuid>[] | null
​
name
string | null
​
name_contains
string | null
​
dataset_version
string | null
​
sort_by
enum<string>
default:start_time
Available options:
name,
start_time,
last_run_start_time,
latency_p50,
latency_p99,
error_rate,
feedback,
runs_count
​
sort_by_desc
boolean
default:true
​
metadata
string | null
​
sort_by_feedback_key
string | null
​
sort_by_feedback_source
enum<string> | null
Available options:
session,
run
​
offset
integer
default:0
Required range: x >= 0
​
limit
integer
default:100
Required range: 1 <= x <= 100
​
tag_value_id
string<uuid>[] | null
​
facets
boolean
default:false
​
filter
string | null
​
include_stats
boolean
default:false
​
use_approx_stats
boolean
default:false
​
stats_start_time
string<date-time> | null
​
stats_select
string[] | null
​
stats_filter
string | null

Response

Successful Response

​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
start_time
string<date-time>
​
end_time
string<date-time> | null
​
extra
Extra · object
​
name
string
​
description
string | null
​
default_dataset_id
string<uuid> | null
​
reference_dataset_id
string<uuid> | null
​
trace_tier
enum<string> | null
Available options:
longlived,
shortlived
​
run_count
integer | null
​
latency_p50
number | null
​
latency_p99
number | null
​
first_token_p50
number | null
​
first_token_p99
number | null
​
total_tokens
integer | null
​
prompt_tokens
integer | null
​
completion_tokens
integer | null
​
total_cost
string | null
​
prompt_cost
string | null
​
completion_cost
string | null
​
last_run_start_time
string<date-time> | null
​
last_run_start_time_live
string<date-time> | null
​
feedback_stats
Feedback Stats · object
​
session_feedback_stats
Session Feedback Stats · object
​
run_facets
Run Facets · object[] | null
​
error_rate
number | null
​
streaming_rate
number | null
​
test_run_number
integer | null