← Back to SiteSmith

Docs & Guides

Everything you need to get set up — from your first scan to wiring the license key API into your own product.

Getting started

  1. Run a free scan. Paste any URL into the scanner on the homepage — no account needed. You'll get an SEO score with a breakdown of meta tags, performance signals, accessibility, and social/OG tags.
  2. Create a free account. Register with just an email — the Starter plan is free forever (3 scans/month, 1 monitor, 1 status page).
  3. Save your scans. Logged in, every scan is stored in your dashboard so you can track a site's score over time and export reports.
  4. Upgrade when you need more. Pro ($19/mo) unlocks unlimited scans, 10 monitors, PDF exports, and priority support. See pricing.

SEO audits

SiteSmith checks 40+ signals across five areas: technical SEO, on-page content, performance, accessibility, and social metadata. Each finding comes with a plain-English recommendation you can hand straight to a client or developer.

Tips

Uptime monitoring & status pages

Add a monitor

  1. In the dashboard, open Monitors → Add Monitor.
  2. Enter the URL to check and an interval. Monitors record response time and up/down state on every check.
  3. Each monitor keeps a log you can review per-check.

Publish a status page

  1. Open Status Pages → New Status Page and pick a slug (e.g. my-agency).
  2. Attach one or more monitors to it.
  3. Share the public link — no login needed for visitors:
GEThttps://sitesmith.tools/status.html?page={slug}

Webhook relay

Create a relay in the dashboard and you get a unique incoming URL. Anything POSTed to it is logged and forwarded to your configured destination — handy for connecting client site forms to Slack, email, or a CRM without writing server code.

POSThttps://sitesmith.tools/api/webhooks/incoming/{your-token}

Every relay keeps a delivery log so you can see exactly what arrived and what was forwarded, and there's a test-fire button in the dashboard for checking your destination before going live.

API reference — license keys

The license key API lets you sell software (plugins, themes, desktop tools) and validate keys from inside your product. Create and manage keys in the dashboard; your app then calls these public endpoints:

Validate a key

POST/api/licenses/validate
{ "license_key": "SS-XXXX-XXXX-XXXX" }

// Response
{
  "valid": true,
  "reason": null,
  "license": {
    "product_name": "My Plugin",
    "customer_email": "buyer@example.com",
    ...
  }
}

valid is false with a human-readable reason when a key is revoked, suspended, or expired.

Activate / deactivate a device

POST/api/licenses/{license-id}/activate
POST/api/licenses/{license-id}/deactivate
{ "device_identifier": "machine-fingerprint-or-domain" }

Activations are counted against the key's max_activations. Deactivating a device frees the slot for another install.

Public status endpoint

GET/api/status/{slug}

Returns the JSON behind a public status page — useful if you want to render uptime inside your own client portal. Rate-limited to 60 requests/minute per IP.

Need higher limits, more endpoints, or a full REST token for your team? That's an Enterprise conversation — tell us what you're building.

Support

Stuck, found a bug, or need a hand getting set up? Email us:

Include the URL or monitor involved and a screenshot if you can — it usually halves the back-and-forth.