JavaScript
import Hyperspell from '@hyperspell/hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const evaluateListQueriesResponse of client.evaluate.listQueries()) {
console.log(evaluateListQueriesResponse.query_id);
}import os
from hyperspell import Hyperspell
client = Hyperspell(
api_key=os.environ.get("HYPERSPELL_API_KEY"), # This is the default and can be omitted
)
page = client.evaluate.list_queries()
page = page.items[0]
print(page.query_id)package main
import (
"context"
"fmt"
"github.com/hyperspell/hyperspell-go"
"github.com/hyperspell/hyperspell-go/option"
)
func main() {
client := hyperspell.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.Evaluate.ListQueries(context.TODO(), hyperspell.EvaluateListQueriesParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}hyperspell evaluate list-queries \
--api-key 'My API Key'curl --request GET \
--url https://api.hyperspell.com/evaluate/queries \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/evaluate/queries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.hyperspell.com/evaluate/queries")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/evaluate/queries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"query_id": "<string>",
"time": "2023-11-07T05:31:56Z",
"query": "<string>",
"user_id": "<string>"
}
],
"next_cursor": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Evaluation
List prior queries
Paginate through all prior queries for the app, newest first.
User tokens only see their own queries; admin tokens see every query in the
app and can narrow to a single user with the user_id filter.
GET
/
evaluate
/
queries
JavaScript
import Hyperspell from '@hyperspell/hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const evaluateListQueriesResponse of client.evaluate.listQueries()) {
console.log(evaluateListQueriesResponse.query_id);
}import os
from hyperspell import Hyperspell
client = Hyperspell(
api_key=os.environ.get("HYPERSPELL_API_KEY"), # This is the default and can be omitted
)
page = client.evaluate.list_queries()
page = page.items[0]
print(page.query_id)package main
import (
"context"
"fmt"
"github.com/hyperspell/hyperspell-go"
"github.com/hyperspell/hyperspell-go/option"
)
func main() {
client := hyperspell.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.Evaluate.ListQueries(context.TODO(), hyperspell.EvaluateListQueriesParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}hyperspell evaluate list-queries \
--api-key 'My API Key'curl --request GET \
--url https://api.hyperspell.com/evaluate/queries \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/evaluate/queries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.hyperspell.com/evaluate/queries")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/evaluate/queries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"query_id": "<string>",
"time": "2023-11-07T05:31:56Z",
"query": "<string>",
"user_id": "<string>"
}
],
"next_cursor": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyAsUser
API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.
Query Parameters
Filter queries by the user that issued them.
Required range:
0 <= x <= 100Was this page helpful?
⌘I