Get dataset run detail
curl --request GET \
--url https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}', 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.zespan.com/v1/datasets/{datasetId}/runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.zespan.com/v1/datasets/{datasetId}/runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"latestEvaluationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_count": {
"items": 123
}
},
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"traceId": "<string>",
"observationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"datasetItem": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": "<unknown>",
"expectedOutput": null
},
"result": {}
}
]
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Get dataset run detail
Fetch a run with every linked item joined to its dataset item content and, if the run has been scored, its evaluation result.
GET
/
v1
/
datasets
/
{datasetId}
/
runs
/
{runId}
Get dataset run detail
curl --request GET \
--url https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}', 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.zespan.com/v1/datasets/{datasetId}/runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.zespan.com/v1/datasets/{datasetId}/runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/datasets/{datasetId}/runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"latestEvaluationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_count": {
"items": 123
}
},
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"datasetItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"traceId": "<string>",
"observationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"datasetItem": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": "<unknown>",
"expectedOutput": null
},
"result": {}
}
]
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Authorizations
Project API key. Manage keys in the Zespan dashboard under project settings.
Query Parameters
Project id. Optional and ignored when authenticating with an API key, since the key already scopes the request to one project.
Was this page helpful?
⌘I

