Skip to main content
POST
/
codenull
/
ai
/
api
/
v1
/
evaluate-website
Evaluate website performance
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>"
}
'
{
  "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": {}
  }
}

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

Successful Response

Response model for website performance statistics.

​
url
string
required
​
desktop
StrategyResults · object
required

Model for strategy-specific results.

​
mobile
StrategyResults · object
required

Model for strategy-specific results.