API Overview

The PixlSEO API provides programmatic access to 30+ platform datasets and functions. All requests go through the canonical domain api.aiseo-reports.com.

The API uses REST conventions with JSON request/response bodies. All endpoints require authentication and are scoped by client_id for multi-tenant security.

API requests are authenticated using API keys:

1. Generate an API key from Settings → API Keys 2. Include the key in the Authorization header: Authorization: Bearer YOUR_API_KEY

API keys are scoped to your agency and can be given specific permissions. Keys can be rotated or revoked at any time.

All API keys are hashed before storage — the full key is only shown once at creation.

API requests are rate-limited to ensure fair usage:

• Standard tier: 100 requests per minute • Burst allowance: Up to 10 requests per second

Rate limit headers are included in every response: • X-RateLimit-Limit — Maximum requests per window • X-RateLimit-Remaining — Requests remaining • X-RateLimit-Reset — Window reset timestamp

Exceeding the limit returns a 429 Too Many Requests response.

The API uses standard HTTP status codes:

• 200 — Success • 400 — Bad request (invalid parameters) • 401 — Unauthorized (missing or invalid API key) • 403 — Forbidden (insufficient permissions) • 404 — Resource not found • 429 — Rate limit exceeded • 500 — Internal server error

Error responses include a JSON body with "error" and "message" fields.

Quick start:

1. Create an API key in Settings → API Keys 2. Make a test request: GET https://api.aiseo-reports.com/v1/clients Authorization: Bearer YOUR_API_KEY 3. Use the client_id from the response to query client-specific data 4. Explore available endpoints in the API Endpoints documentation

All POST endpoints return the generated/created data directly in the response body.