# SearchOps - Technical SEO Monitoring Platform

> SearchOps is an automated SEO health monitoring tool that crawls websites, detects issues, and compares against Google Search Console data.

## Overview

SearchOps helps SEO professionals and web developers maintain optimal search engine visibility by:
- Automated site crawling with configurable depth and frequency
- URL status and label tracking (index, noindex, redirect, fix, delete, needs-content)
- Alert detection for common SEO issues
- Google Search Console CSV import and comparison
- Dashboard with real-time metrics and visualizations

## API Endpoints

All API endpoints use JSON and follow REST conventions.

### Health & Status
- GET /api/health - Service health check
- GET /api/docs - API documentation

### Sites
- GET /api/sites - List all monitored sites
- POST /api/sites - Add a new site to monitor
- GET /api/sites/:id - Get site details
- PATCH /api/sites/:id - Update site settings

### Crawling
- POST /api/crawl - Start a new crawl run
- GET /api/dashboard?siteId=:id - Get dashboard stats for a site
- GET /api/urls?siteId=:id - Get crawled URLs with pagination and filtering

### Alerts
- GET /api/alerts?siteId=:id - Get active alerts
- POST /api/alerts/:id/resolve - Resolve an alert

### GSC Integration
- POST /api/gsc/import - Import Google Search Console CSV data

## Data Models

### URL Labels
- index: Pages that should be indexed
- noindex: Pages marked as noindex
- redirect: Redirecting URLs
- fix: Pages requiring attention
- delete: Pages recommended for removal
- needs-content: Thin content pages

### Alert Types
- new_5xx: Server errors detected
- new_4xx: Client errors detected
- redirect_chain: Multiple redirect hops
- canonical_drift: Canonical URL changes
- noindex_drift: Noindex status changes
- robots_block: Blocked by robots.txt
- placeholder_text: Lorem ipsum or placeholder content
- thin_content: Low word count pages
- missing_title: Missing page title
- missing_description: Missing meta description
- schema_missing: No structured data
- sitemap_missing: URL not in sitemap
- orphan_url: No internal links pointing to page
- large_image: Unoptimized images
- gsc_mismatch: Discrepancy with GSC data

## Authentication

Protected crawl, import, setup, and mutation endpoints require PLATPHORM_API_KEY:
```
Authorization: Bearer $PLATPHORM_API_KEY
X-PlatPhorm-API-Key: $PLATPHORM_API_KEY
```

## Rate Limits

- Standard: 100 requests per minute
- Crawl: 10 concurrent requests per site

## More Information

- API Reference: https://searchops.platphormnews.com/api/docs
- Setup: https://searchops.platphormnews.com/setup
- Support: support@platphormnews.com