Documentation

How to run audits, read reports, and share results.

This page explains Orilyt usage in plain terms. It focuses on the UI and report logic.

Read why automated audits fail without context →

This page explains Orilyt usage in plain terms. It focuses on the UI and report logic.

Run an audit

  • Public landing: enter a URL → a public (restricted) report is generated.
  • Dashboard: enter a URL → a full report is generated and saved in your audit history.
Orilyt is read-only. It does not require admin access and does not change the audited website.

Dashboard

The dashboard is your central hub. It uses a master-detail layout: your sites on the left, audit history on the right.

Sites management

  • Add a site by entering its URL. Orilyt creates the site record and runs the first audit automatically.
  • Each site card shows the domain, latest score, and score trend (up, down, or stable).
  • Search and filter sites by name. Pagination handles large portfolios (20 sites per page).
  • Deactivate a site to free up a slot on your plan. Deactivation also stops monitoring.

Audit history

  • Click a site to see its full audit history with sortable columns (date, global score, and per-section scores).
  • Filter by date and adjust rows per page (15, 50, or 100). Click any row to open the full report.
  • Relaunch an audit at any time with the "Run audit" button. Progress is shown in real time (56 checks).

Multipage audits

  • Multipage audits crawl several pages of the same site (via sitemap or manual list) and produce a consolidated report.
  • Results include site-wide scores, per-page breakdowns, and top issues across all pages.

Monitoring

  • Enable monitoring per site (paid plans). Orilyt checks SSL, uptime, and score changes at regular intervals.
  • Alerts appear in the dashboard and are sent by email when a problem is detected.
  • Monitoring frequency depends on your plan. Deactivating a site automatically stops its monitoring.

Credits

  • Your credit balance is displayed at the top. Each audit costs 1 credit; multipage audits cost more depending on the number of pages.
  • Free plan: 20 credits/month for 1 site. Paid plans include monthly credits with rollover.
  • When credits run out, Orilyt shows upgrade options (plan upgrade or credit pack purchase).
Site limits and credit quotas depend on your plan. You can manage your subscription from the Account page.

Public vs private reports

Public report (restricted)
Shows the test list and scores, but hides full drawer content and the long AI summary.
Private report (owner)
Shows full drawer content (facts, recommended actions, verification steps) and the full AI summary.
In public restricted mode, Orilyt does not ship the full drawer HTML to the browser (prevents leaks via source/JSON).

How to read the report

  • Priority view groups the most important items first.
  • Section views (Performance / Security / SEO / UX / Legal) group tests by theme.
  • Statuses are simplified: OK, To improve, Critical.
Scores are indicators. Always use the Verification steps in drawers after you apply changes.

Drawers (details)

Each test opens a drawer with a stable structure:

  • Facts (observed): what was measured or detected.
  • Interpretation: decision-ready summary.
  • Why this matters: practical impact.
  • What to do (recommended): the fix.
  • Verification: how to confirm the fix worked.
Some drawers include code snippets (a black box with a Copy button). Use them as-is, but test on staging when possible.

Sharing a report

  • Only the report owner (logged in) can enable, refresh, or disable a share link.
  • A shared link opens the report in public restricted mode.
  • Clients can view the report (read-only), but cannot access full drawer content.
This is intentional: public sharing is meant for communication, not for exposing all technical remediation steps.

PDF export

Orilyt generates two types of PDF directly from the report page — no browser print needed.

  • From any report, use the two PDF buttons in the sticky bar: "Client PDF" and "Technical PDF".
  • Both modes work for single-page and multipage reports.
  • Client PDF: executive AI summary, simplified test cards (score + key recommendation). Ideal for presenting to clients.
  • Technical PDF: full drawer content (facts, actions, verification), plus technical appendix (PageSpeed, Safe Browsing, server info).
White-label settings (logo, colors, company name) are automatically applied to PDF exports.

Account & settings

The account page lets you manage your profile, subscription, and branding.

Profile

  • View and change your email address. A verification email is sent to the new address before it takes effect.
  • Your email verification status is shown. Unverified accounts have limited functionality.

Subscription & billing

  • View your current plan, status, and included features (site limit, API quota, multipage URLs, white-label access).
  • Manage your subscription (upgrade, downgrade, cancel) via the Stripe billing portal.
  • Credit balance breakdown: see your remaining credits by origin (free, pack, subscription) and upcoming expirations.

White-label (paid plans)

  • Enable white-label to replace Orilyt branding with your own on reports and PDFs.
  • Customize: company name, contact info, primary and secondary colors.
  • Upload your logo and favicon (PNG, JPG, or SVG, max 500 KB). Drag-and-drop supported.
  • Add a custom footer text that appears on exported PDFs.
White-label is available on paid plans only. Changes apply to all future reports and PDF exports.

Promo codes

  • Enter a promo code to receive bonus credits or a discount on your next subscription.

Delete account

  • Account deletion is permanent. You must enter your password and confirm. If you have an active subscription, cancel it first via the billing portal.

Limitations

  • Audits are based on what is reachable over HTTP at scan time (timeouts, WAF, blocks can affect results).
  • Some checks are not measurable on a given page sample (example: no images → lazy-loading cannot be evaluated).
  • Scores are not guarantees. Use them to prioritize, then verify.

REST API

Orilyt provides a REST API that lets you run audits and retrieve results programmatically. This is useful for agencies, developers, and anyone who wants to integrate website audits into their own tools (CRM, dashboards, CI/CD).

Authentication

Every API request must include your API key. You can find and manage your keys on the API Keys page.

Three methods are supported (pick one):

  • Header (recommended)
    Authorization: Bearer YOUR_API_KEY
  • Custom header
    X-API-Key: YOUR_API_KEY
  • Query parameter (least secure — visible in logs)
    GET /api_v1.php?url=example.com&key=YOUR_API_KEY

Run an audit

Launch a new audit on a given URL. This counts as 1 API call against your plan's monthly API quota.

curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://orilyt.com/api_v1.php?url=example.com"
  • url — The website URL to audit (required).

On success the response contains the full audit results under the data key, plus metadata.

{ "status": "ok", "data": { /* full audit results */ }, "audit_id": 142, "site_id": 38, "user_id": 12 }

Retrieve an audit

Fetch the full JSON result of a previously run audit. This is read-only and does not count against your API quota.

curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://orilyt.com/api_v1.php?audit_id=142"
  • audit_id — The numeric audit ID (required). You can find it in the report URL or in the response of a run request.
You can only retrieve audits that belong to your account.

Error codes

All errors return a JSON object with status, code, and error fields.

HTTPCodeDescription
400missing_urlMissing or invalid parameter (e.g. no URL provided).
401auth_requiredMissing or invalid API key.
403audit_forbiddenValid key but no permission (wrong owner, or plan does not include API access).
404audit_not_foundAudit not found.
429rate_limitedRate limit exceeded (too many requests per minute).

Quotas by plan

Each plan includes a monthly API call quota. Web audits (dashboard) are unlimited on paid plans and do not consume API calls.

Plan Sites API calls / month API access API keys
Free 1 0 No 0
Solo — 39 € 3 50 Yes 2
Pro — 99 € 10 200 Yes 5
Business — 199 € 30 500 Yes 10
Agency — 449 € 100 2,000 Yes 20

Full example

Run an audit, then retrieve it later:

# 1. Run an audit curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://orilyt.com/api_v1.php?url=example.com" # Response includes audit_id (e.g. 142) # 2. Retrieve the same audit later curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://orilyt.com/api_v1.php?audit_id=142"

Glossary

Drawer
A detail panel for a specific test.
Public restricted
Public report mode that hides full details to prevent data leakage.
Verification
Steps to confirm a fix worked (headers, redirects, HTML output, etc.).
Read-only scan
The audit does not change the target website and does not require admin access.