Insert results for a website evaluation
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"results": [
{
"url": "<string>",
"eval_score": 123,
"semantic": 123,
"crawlability": 123,
"readability": 123,
"recommendation": "<string>",
"details": {}
}
]
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results"
payload = { "results": [
{
"url": "<string>",
"eval_score": 123,
"semantic": 123,
"crawlability": 123,
"readability": 123,
"recommendation": "<string>",
"details": {}
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
results: [
{
url: '<string>',
eval_score: 123,
semantic: 123,
crawlability: 123,
readability: 123,
recommendation: '<string>',
details: {}
}
]
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'results' => [
[
'url' => '<string>',
'eval_score' => 123,
'semantic' => 123,
'crawlability' => 123,
'readability' => 123,
'recommendation' => '<string>',
'details' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results"
payload := strings.NewReader("{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.post("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"urls": [
"<string>"
],
"is_archived": true,
"generation_cost": 123,
"tags": [
"<string>"
]
}Website Evaluation
Insert results for a website evaluation
Insert one or more results for a website evaluation. Each result must include a url, and evaluation metrics. Required permission: authenticated.
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
website_evaluations
/
{id}
/
insert_results
Insert results for a website evaluation
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"results": [
{
"url": "<string>",
"eval_score": 123,
"semantic": 123,
"crawlability": 123,
"readability": 123,
"recommendation": "<string>",
"details": {}
}
]
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results"
payload = { "results": [
{
"url": "<string>",
"eval_score": 123,
"semantic": 123,
"crawlability": 123,
"readability": 123,
"recommendation": "<string>",
"details": {}
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
results: [
{
url: '<string>',
eval_score: 123,
semantic: 123,
crawlability: 123,
readability: 123,
recommendation: '<string>',
details: {}
}
]
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'results' => [
[
'url' => '<string>',
'eval_score' => 123,
'semantic' => 123,
'crawlability' => 123,
'readability' => 123,
'recommendation' => '<string>',
'details' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results"
payload := strings.NewReader("{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.post("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/insert_results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"results\": [\n {\n \"url\": \"<string>\",\n \"eval_score\": 123,\n \"semantic\": 123,\n \"crawlability\": 123,\n \"readability\": 123,\n \"recommendation\": \"<string>\",\n \"details\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"urls": [
"<string>"
],
"is_archived": true,
"generation_cost": 123,
"tags": [
"<string>"
]
}Authorizations
Path Parameters
A UUID string identifying this website evaluation.
A UUID string identifying the organization.
A UUID string identifying the workspace.
Body
application/json
List of results to insert for this evaluation
Show child attributes
Show child attributes
Response
200 - application/json
Maximum string length:
200Maximum string length:
600Maximum string length:
200pending- pendingin_progress- in progresscompleted- completedpartial- partialfailed- failed
Available options:
pending, in_progress, completed, partial, failed Was this page helpful?
⌘I