API Documentation

Integrate PlatPhorm Insights into your applications and AI agents

Analyze URL

Run a full performance analysis on any URL

POST /api/v1/analyze

{
  "url": "https://example.com",
  "strategy": "mobile",
  "categories": ["performance", "accessibility", "seo", "best-practices"]
}

Response:
{
  "id": "uuid",
  "url": "https://example.com",
  "strategy": "mobile",
  "scores": {
    "performance": 85,
    "accessibility": 92,
    "bestPractices": 88,
    "seo": 95
  },
  "coreWebVitals": {
    "lcp": 2.1,
    "fcp": 1.2,
    "cls": 0.05,
    "ttfb": 0.6,
    "inp": 150
  },
  "opportunities": [...],
  "aiRecommendations": [...],
  "security": {...},
  "carbon": {...}
}

Compare URLs

Compare performance metrics between multiple URLs

POST /api/v1/compare

{
  "urls": [
    "https://mysite.com",
    "https://competitor1.com",
    "https://competitor2.com"
  ],
  "strategy": "mobile"
}

Get Results

Retrieve a previously completed analysis

GET /api/v1/results/{id}

Returns the full analysis result by ID.

Need Help?

View the full API specification at /api/docs or read the LLM context files.