API Changelog

Track API changes, new features, and breaking changes. We follow semantic versioning and maintain backward compatibility within major versions.

Versioning Policy

The SEOGEO Tools API uses URL-based versioning (/api/public/v1). Our versioning policy:

• Major versions (v1 → v2): May contain breaking changes. We maintain old versions for 12 months after deprecation.
• Minor updates: New endpoints, new optional fields. Always backward compatible.
• Patch updates: Bug fixes, documentation updates. No API changes.

Current Version: v1

Status: Stable Released: January 2025 Support: Active

Changelog

January 2025

v1.0.0 - Initial Release

New endpoints:

• GET /me - Get current user info
• GET /projects - List projects with pagination
• POST /projects - Create new project
• GET /projects/:id - Get project with stats
• GET /projects/:id/audits - List audit runs
• POST /projects/:id/audits - Start new audit
• GET /projects/:id/audits/:auditId/pages - List audit pages with filters
• GET /projects/:id/drafts - List content drafts
• POST /projects/:id/content/briefs - Create content brief
• GET /projects/:id/reports - List report snapshots
• POST /projects/:id/geo-monitor/tests - Start GEO test

Features:

• Bearer token authentication with API keys
• Rate limiting with X-RateLimit headers
• Idempotency support for POST requests
• Page-based pagination (max 100 per page)
• OpenAPI 3.1 specification at /openapi.json

Deprecation Policy

When deprecating an endpoint or field:

1. Announcement: 90 days advance notice via changelog and email
2. Warning header: Deprecation header added to responses
3. Documentation: Marked as deprecated with migration guide
4. Removal: After deprecation period ends

Migration Guides

No migrations required yet.

Upcoming Changes

No breaking changes planned.

Subscribe to Updates

• Check this page regularly
• Follow @seogeotools for announcements
• Enable API notifications in Settings