Configure Table Sheet Scorecard
curl --request PATCH \
--url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"aggregation": {},
"evaluated_column_ids": [],
"steps": [],
"display_config": {},
"baseline_config": {}
}
'import requests
url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard"
payload = {
"name": "<string>",
"aggregation": {},
"evaluated_column_ids": [],
"steps": [],
"display_config": {},
"baseline_config": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
aggregation: {},
evaluated_column_ids: [],
steps: [],
display_config: {},
baseline_config: {}
})
};
fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard', 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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'aggregation' => [
],
'evaluated_column_ids' => [
],
'steps' => [
],
'display_config' => [
],
'baseline_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.patch("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"scorecard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": 123,
"smart_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sheet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"evaluated_column_ids": [
"<string>"
],
"aggregation": {
"method": "<string>",
"pass_threshold": 123,
"warn_threshold": 123
},
"stale_state": {
"is_stale": true,
"reasons": [
"<string>"
],
"stale_step_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stale_row_indices": [
1
]
},
"steps": [
{
"title": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_column_ids": [
"<string>"
],
"weight": 123,
"required": true,
"thresholds": {},
"primitive_config": {},
"score_adapter": {},
"description": "<string>",
"target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_index": 123,
"backing_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_config": {},
"baseline_config": {},
"latest_calculation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>"
},
"version": 123
}{
"success": false,
"message": "<string>",
"error": "<string>"
}{
"success": false,
"message": "<string>",
"error": "<string>"
}{
"success": false,
"message": "<string>",
"error": "<string>"
}Tables
Configure Scorecard
Create or update the active scorecard for a table sheet.
PATCH
/
api
/
public
/
v2
/
tables
/
{table_id}
/
sheets
/
{sheet_id}
/
scorecard
Configure Table Sheet Scorecard
curl --request PATCH \
--url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"aggregation": {},
"evaluated_column_ids": [],
"steps": [],
"display_config": {},
"baseline_config": {}
}
'import requests
url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard"
payload = {
"name": "<string>",
"aggregation": {},
"evaluated_column_ids": [],
"steps": [],
"display_config": {},
"baseline_config": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
aggregation: {},
evaluated_column_ids: [],
steps: [],
display_config: {},
baseline_config: {}
})
};
fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard', 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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'aggregation' => [
],
'evaluated_column_ids' => [
],
'steps' => [
],
'display_config' => [
],
'baseline_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.patch("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/scorecard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"aggregation\": {},\n \"evaluated_column_ids\": [],\n \"steps\": [],\n \"display_config\": {},\n \"baseline_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"scorecard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": 123,
"smart_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sheet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"evaluated_column_ids": [
"<string>"
],
"aggregation": {
"method": "<string>",
"pass_threshold": 123,
"warn_threshold": 123
},
"stale_state": {
"is_stale": true,
"reasons": [
"<string>"
],
"stale_step_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stale_row_indices": [
1
]
},
"steps": [
{
"title": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_column_ids": [
"<string>"
],
"weight": 123,
"required": true,
"thresholds": {},
"primitive_config": {},
"score_adapter": {},
"description": "<string>",
"target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_index": 123,
"backing_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_config": {},
"baseline_config": {},
"latest_calculation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>"
},
"version": 123
}{
"success": false,
"message": "<string>",
"error": "<string>"
}{
"success": false,
"message": "<string>",
"error": "<string>"
}{
"success": false,
"message": "<string>",
"error": "<string>"
}Create or update the active scorecard for a sheet.
name and aggregation are required. evaluated_column_ids and steps are optional and default to empty lists.Authorizations
Headers
Your PromptLayer API key. The key's workspace scopes table resources for this request.
Body
application/json
Was this page helpful?
⌘I

