Evaluate Website

API endpoint to evaluate website performance and provide recommendations

POST /codenull/ai/api/v1/evaluate-website

Evaluate website performance

cURL

curl --request POST \
  --url https://api.example.com/codenull/ai/api/v1/evaluate-website \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "project_id": "<string>"
}
'

import requests

url = "https://api.example.com/codenull/ai/api/v1/evaluate-website"

payload = {
    "url": "<string>",
    "project_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', project_id: '<string>'})
};

fetch('https://api.example.com/codenull/ai/api/v1/evaluate-website', 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.example.com/codenull/ai/api/v1/evaluate-website",
  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([
    'url' => '<string>',
    'project_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.example.com/codenull/ai/api/v1/evaluate-website"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"project_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.example.com/codenull/ai/api/v1/evaluate-website")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"project_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/codenull/ai/api/v1/evaluate-website")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"project_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "url": "<string>",
  "desktop": {
    "performance_score": 123,
    "first_contentful_paint": 123,
    "speed_index": 123,
    "largest_contentful_paint": 123,
    "time_to_interactive": 123,
    "total_blocking_time": 123,
    "cumulative_layout_shift": 123,
    "loading_experience": {
      "id": "<string>",
      "metrics": {
        "first_contentful_paint": {},
        "first_input_delay": {},
        "largest_contentful_paint": {},
        "cumulative_layout_shift": {},
        "interaction_to_next_paint": {}
      },
      "overall_category": "<string>",
      "initial_url": "<string>"
    },
    "origin_loading_experience": {
      "id": "<string>",
      "metrics": {
        "first_contentful_paint": {},
        "first_input_delay": {},
        "largest_contentful_paint": {},
        "cumulative_layout_shift": {},
        "interaction_to_next_paint": {}
      },
      "overall_category": "<string>",
      "initial_url": "<string>"
    },
    "opportunities": [
      {}
    ],
    "diagnostics": [
      {}
    ],
    "categories": {}
  },
  "mobile": {
    "performance_score": 123,
    "first_contentful_paint": 123,
    "speed_index": 123,
    "largest_contentful_paint": 123,
    "time_to_interactive": 123,
    "total_blocking_time": 123,
    "cumulative_layout_shift": 123,
    "loading_experience": {
      "id": "<string>",
      "metrics": {
        "first_contentful_paint": {},
        "first_input_delay": {},
        "largest_contentful_paint": {},
        "cumulative_layout_shift": {},
        "interaction_to_next_paint": {}
      },
      "overall_category": "<string>",
      "initial_url": "<string>"
    },
    "origin_loading_experience": {
      "id": "<string>",
      "metrics": {
        "first_contentful_paint": {},
        "first_input_delay": {},
        "largest_contentful_paint": {},
        "cumulative_layout_shift": {},
        "interaction_to_next_paint": {}
      },
      "overall_category": "<string>",
      "initial_url": "<string>"
    },
    "opportunities": [
      {}
    ],
    "diagnostics": [
      {}
    ],
    "categories": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Example Usage

For complete API documentation and examples, please refer to your Swagger UI.

curl -X 'POST' \
  'https://localhost:8080/codenull/ai/api/v1/evaluate-website' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com"
}'

Query Parameters

category · string[]

Categories to analyze (PERFORMANCE, ACCESSIBILITY, BEST_PRACTICES, SEO, PWA)

Body

application/json

Request model for website evaluation.

url · string<uri> · required

Required string length: 1 - 2083

project_id · string · required

Response

200

application/json

Successful Response

Response model for website performance statistics.

url · string · required

desktop · StrategyResults · object · required

Model for strategy-specific results.

Show child attributes

mobile · StrategyResults · object · required

Model for strategy-specific results.

Show child attributes