How to integrate Orilyt audits into your agency workflow with the API
Automate audits, feed results to your CRM, and build client dashboards — all through a simple REST API.
- Run and retrieve WordPress audits programmatically via REST
- No SDK needed — standard HTTP with Bearer token authentication
- Results integrate directly into CRMs, dashboards, or monitoring scripts
If you manage more than a handful of WordPress sites, you already know the pain: logging in, running audits one by one, copying results into spreadsheets or client portals. It works — until it doesn't scale.
The Orilyt API solves this by letting you trigger and retrieve audits programmatically. Whether you want to feed results into your CRM, build a client-facing dashboard, or automate weekly monitoring — it all starts with a simple HTTP request.
What the API does
The API exposes two endpoints. The first runs a new WordPress audit: send a URL, get back a full JSON report with scores, test results, and metadata. The second retrieves an existing audit by its ID — useful when you want to fetch results later or build historical comparisons.
Both endpoints return structured JSON, making it straightforward to parse and display results in any tool or interface you already use.
Authentication in 30 seconds
Generate an API key from your Orilyt dashboard. Then include it in every request using one of three methods: a standard Bearer token in the Authorization header (recommended), a custom X-API-Key header, or as a query parameter. That's it — no OAuth flows, no SDK to install, no complex setup.
Your API key shares the same credit pool as the web interface, so every audit you run via API counts toward your monthly quota.
Real-world use cases
Agencies use the API in surprisingly diverse ways. The most common pattern is CRM integration: after onboarding a new client, automatically run an audit and attach the results to their contact record. Sales teams love this because it turns a manual pre-sales task into a one-click action.
Another popular use case is automated weekly monitoring. A simple cron job runs audits on all client sites every Monday morning. If a score drops below a threshold, your team gets an alert. No manual checking, no missed regressions.
Some agencies go further and build client-facing dashboards that display live audit data — turning Orilyt into a white-label monitoring service embedded in their own portal.
A complete example
Here is how you run an audit and retrieve the results using curl. First, trigger the audit:
The response includes an audit_id along with the full results. To retrieve the same audit later:
The JSON response contains the global score, individual test results with statuses (OK, To improve, Critical), and metadata like the audit date and tested URL. You can parse this in any language — Python, JavaScript, PHP, Go — with standard JSON libraries.
Quotas and plans
API access is available on all paid plans. Credits are shared between the web interface and the API: if your plan includes 50 monthly audits, you can use them however you want. Retrieving an existing audit does not consume credits.
Need more details? Check out the full documentation or the pricing page.
Conclusion
The Orilyt API is designed for agencies and freelancers who want to move beyond manual audits. With two endpoints, standard HTTP authentication, and structured JSON responses, integration takes minutes — not days.
Whether you automate monitoring, enrich your CRM, or build a client portal, the API lets you turn WordPress audits into a scalable part of your workflow.