API Reference
health-check
chat-completion
optimize-seo
evaluate-website
generate-website-get
generate-website-post
evaluate-website
Evaluate website performance
Analyzes a URL for both desktop and mobile strategies and returns performance metrics as JSON.
POST
/
codenull
/
ai
/
api
/
v1
/
evaluate-website
Copy
{
"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
Categories to analyze (PERFORMANCE, ACCESSIBILITY, BEST_PRACTICES, SEO, PWA)
Body
application/json
Request model for website evaluation.
Response
200
application/json
Successful Response
Response model for website performance statistics.
Copy
{
"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": {}
}
}
Assistant
Responses are generated using AI and may contain mistakes.