Docschevron_rightGetting Startedchevron_rightIntroduction

Introduction to PrismAudit

PrismAudit is a high-performance SEO analysis engine designed for scale and precision. It provides programmatic access to technical SEO audits, Core Web Vitals monitoring, and comprehensive rank tracking.

Overview

Built for enterprise teams and sophisticated agencies, PrismAudit bypasses superficial metrics to deliver actionable, data-dense insights. Our system is composed of several modular engines that can be utilized independently or as a unified suite.

speed

High-Concurrency Crawler

Analyze up to 100,000 URLs per audit with custom user-agents, JavaScript rendering, and localized IP rotation.

monitoring

Vitals Monitor

Continuous lab and field data collection for LCP, FID, and CLS via seamless performance data integration.

Authentication

To interact with the PrismAudit API, you need to include your API key in the `Authorization` header of your HTTP requests.

// Example: Authenticating a request via cURL
curl -X GET "https://api.prismaudit.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
info

Security Best Practice

Never expose your API key in client-side code (e.g., browser-based JavaScript). Always route API requests through a secure backend server.

Quick SDK Initialization

We provide official SDKs for Node.js and Python. Here is how to initialize the Node.js client:

import { PrismClient } from '@prismaudit/sdk';

// Initialize the client
const prism = new PrismClient({
  apiKey: process.env.PRISM_API_KEY,
  environment: 'production'
});

// Trigger an audit
async function runAudit() {
  const result = await prism.audit.start({
    targetUrl: 'https://example.com',
    strategy: 'mobile',
    maxDepth: 3
  });
  console.log(`Audit initiated. ID: ${result.auditId}`);
}
Installationarrow_forward