Website Evaluation

Get the HTML of a website evaluation result

Return the HTML of a page the GEO audit analysed, as the crawler fetched it: no_js is what an AI crawler that does not run JavaScript receives, js_rendered the page after its JavaScript ran. Long pages can be read in chunks with offset and limit, counted in characters; next_offset gives the next chunk and is null on the last one. Each result of the audit gives the length of both versions (no_js_html_chars, js_rendered_html_chars); a null length means no HTML is stored, and this endpoint then returns 404.

GET

organizations

{organization_id}

workspaces

{workspace_id}

website_evaluations

{id}

results

{result_id}

html

Get the HTML of a website evaluation result

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

import requests

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

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/{id}/results/{result_id}/html', 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}/results/{result_id}/html",
  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/{id}/results/{result_id}/html"

	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/{id}/results/{result_id}/html")
  .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/{id}/results/{result_id}/html")

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

{
  "html_type": "no_js",
  "total_chars": 123,
  "offset": 123,
  "next_offset": 123,
  "content": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

string<uuid>

required

A UUID string identifying this website evaluation.

organization_id

string<uuid>

required

A UUID string identifying the organization.

result_id

string<uuid>

required

A UUID string identifying the website evaluation result.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Query Parameters

html_type

enum<string>

required

no_js: the HTML as served, without running JavaScript, which is what most AI crawlers receive. js_rendered: the HTML after the page's JavaScript ran in a browser.

no_js - no_js
js_rendered - js_rendered

Available options:

no_js,

js_rendered

Minimum string length: 1

limit

integer

Return at most this many characters. Without it, the page is returned from offset to its end. Pages over 50,000 characters are too large for most agents to read at once.

Required range: x >= 1

offset

integer

default:0

First character to return. Use the next_offset of the previous chunk.

Required range: x >= 0

Response

html_type

enum<string>

required

no_js - no_js
js_rendered - js_rendered

Available options:

no_js,

js_rendered

total_chars

integer

required

Length of the whole page, in characters.

offset

integer

required

Position of the first character of content in the page.

next_offset

integer | null

required

The offset that reads the next chunk; null on the last chunk.

content

string

required

The HTML from offset, at most limit characters.

Get the HTML of a website evaluation result

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

import requests

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

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/{id}/results/{result_id}/html', 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}/results/{result_id}/html",
  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/{id}/results/{result_id}/html"

	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/{id}/results/{result_id}/html")
  .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/{id}/results/{result_id}/html")

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

{
  "html_type": "no_js",
  "total_chars": 123,
  "offset": 123,
  "next_offset": 123,
  "content": "<string>"
}

Overview

Core API

Search API

Get the HTML of a website evaluation result

Authorizations

Path Parameters

Query Parameters

Response