SEO Page Analysis API Documentation

Introduction

The SEO Page Analysis API allows you to analyze a web page for SEO-related metrics. It performs checks based on predefined criteria and provides a detailed report, including scores, metrics, and individual check results. This documentation outlines how to use the API, including endpoint information, request formats, and sample responses.

Base URL

The base URL for the API is https://seox.p.rapidapi.com/.

Endpoint

• URL: /api/seo
• Method: GET

Query Parameters

• url (required): The URL of the web page to analyze.

Response

The API responds with a JSON object containing SEO analysis results.

Example Response:

{
  "success": true,
  "message": "SEO analysis completed successfully",
  "data": {
    "score": 85,
    "metrics": {
      "pass": 12,
      "fail": 3,
      "total": 15
    },
    "url": "https://example.com",
    "time": "2023-01-01 12:00:00",
    "responseTime": 500,
  },
  "checks": [
    {
      "name": "Check 1",
      "result": "success",
      "points": 5,
      "message": "Check 1 passed successfully",
      "url": "https://example.com/check1"
    },
    {
      "name": "Check 2",
      "result": "error",
      "points": "-3",
      "message": "Check 2 failed",
      "url": "https://example.com/check2"
    },
    // Additional check results...
  ]
}

400 Bad Request:

If the url parameter is missing.

{
  "error": "Missing URL parameter"
}

500 Internal Server Error:

If an unexpected error occurs during the analysis process.

{
  "error": "Internal Server Error"
}

Example Usage

cURL Command

curl "https://seox.p.rapidapi.com/page-analysis?url=https://example.com"

JavaScript (axios)

const axios = require('axios');

const url = 'https://example.com';

axios.get(`https://seox.p.rapidapi.com/page-analysis?url=${url}`)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error.response ? error.response.data : error.message);
  });