Website Evaluation

List website evaluations

List the GEO audits of the workspace, each with its average score and url_count and, unless include_results is false, its per-URL results. The results carry every URL’s full metric breakdown, so the list grows with audits × URLs: pass include_results=false to browse, and ordering, limit and offset to page. An audit is pending until the crawler reports its final status: completed when every URL was fully measured, partial when at least one URL is partial or failed, failed when none could be measured. Each entry of results says which URL is partial or failed (status) and why (status_reason, status_message): a partial URL keeps the scores that could be measured, and a dimension that could not be is scored 0. Results stored before URL outcomes were recorded have a null status and status_reason.

GET

organizations

{organization_id}

workspaces

{workspace_id}

website_evaluations

List website evaluations

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations', 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",
  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: <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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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,
    "url_count": 123,
    "score": 123,
    "tags": [
      "<string>"
    ],
    "status": "pending",
    "include_discovery": true,
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "eval_score": 123,
        "crawlability": 123,
        "semantic": 123,
        "readability": 123,
        "discovery": 123,
        "recommendation": "<string>",
        "status": "completed",
        "status_reason": "<string>",
        "status_message": "<string>",
        "no_js_html_chars": 123,
        "js_rendered_html_chars": 123,
        "details": "<unknown>"
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

organization_id

string<uuid>

required

A UUID string identifying the organization.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Query Parameters

include_results

boolean

default:true

Embed each audit's per-URL results. Set it to false to get the summaries only (score, url_count), then read the audit you need with retrieve_website_evaluation.

limit

integer

Return at most this many audits.

Required range: x >= 1

offset

integer

default:0

Skip this many audits first.

Required range: x >= 0

ordering

enum<string>

default:-created_at

Order of the audits: newest first (default), or by average score.

-created_at - -created_at
score - score
-score - -score

Available options:

-created_at,

score,

-score

Minimum string length: 1

Response

200 - application/json

string<uuid>

required

read-only

created_at

string<date-time>

required

read-only

created_by

string<uuid> | null

required

read-only

workspace_id

string<uuid>

required

name

string

required

Maximum string length: 200

urls

string<uri>[]

required

Maximum string length: 2000

is_archived

boolean

required

read-only

generation_cost

integer

required

read-only

url_count

integer

required

Number of distinct URLs with a result.

score

number<double>

required

Average eval_score of the results, 0 when there is none.

tags

string[]

Maximum string length: 200

status

enum<string>

pending - pending
in_progress - in progress
completed - completed
partial - partial
failed - failed

Available options:

pending,

in_progress,

completed,

partial,

failed

include_discovery

boolean

results

object[]

Absent when listed with include_results=false.

Show child attributes

List website evaluations

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations', 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",
  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: <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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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,
    "url_count": 123,
    "score": 123,
    "tags": [
      "<string>"
    ],
    "status": "pending",
    "include_discovery": true,
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "eval_score": 123,
        "crawlability": 123,
        "semantic": 123,
        "readability": 123,
        "discovery": 123,
        "recommendation": "<string>",
        "status": "completed",
        "status_reason": "<string>",
        "status_message": "<string>",
        "no_js_html_chars": 123,
        "js_rendered_html_chars": 123,
        "details": "<unknown>"
      }
    ]
  }
]

Overview

Core API

Search API

List website evaluations

Authorizations

Path Parameters

Query Parameters

Response