# Website Quality Audit (`hamzamihaidaniel/siteone-website-audit`) Actor Audit public websites for SEO, security, accessibility, performance, redirects, and technical issues. Get structured results plus interactive HTML and JSON reports. - **URL**: https://apify.com/hamzamihaidaniel/siteone-website-audit.md - **Developed by:** [Hamza Mihai Daniel](https://apify.com/hamzamihaidaniel) (community) - **Categories:** SEO tools, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 page scanneds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## SiteOne Website Audit Actor Audit a public website for SEO, security, accessibility, performance, and best-practice problems. The Actor wraps the open-source [SiteOne Crawler](https://github.com/janreges/siteone-crawler) and turns its reports into Apify-native datasets and files. ### What you get - Overall website quality score from 0 to 10. - Category scores for performance, SEO, security, accessibility, and best practices. - One dataset row for each audited HTML page or redirect. - Actionable critical, warning, and notice findings. - A complete structured JSON report. - A self-contained interactive HTML report. - Scheduling, API, webhook, Make, Zapier, n8n, and MCP compatibility through Apify. ### Input | Field | Description | Default | | --- | --- | --- | | `startUrl` | Public HTTP or HTTPS website | Required | | `preset` | HTML report focus | `full` | | `singlePage` | Audit only the start page | `false` | | `device` | Desktop, mobile, or tablet user agent | `desktop` | | `maxVisitedUrls` | Maximum pages and assets fetched | `100` | | `maxDepth` | Maximum page path depth; `0` is unlimited | `0` | | `requestsPerSecond` | Global request rate | `5` | | `workers` | Concurrent requests | `2` | | `timeoutSecs` | Per-request timeout | `10` | | `removeQueryParameters` | Avoid duplicate URLs and crawler traps | `true` | | `includePatterns` | Optional PCRE-compatible include filters | `[]` | | `excludePatterns` | Optional PCRE-compatible exclude filters | `[]` | Example: ```json { "startUrl": "https://example.com", "preset": "full", "singlePage": false, "device": "mobile", "maxVisitedUrls": 250, "maxDepth": 4, "requestsPerSecond": 5, "workers": 2, "timeoutSecs": 10, "removeQueryParameters": true, "excludePatterns": ["/logout", "/cart"] } ```` ### Output The default dataset contains three record types: - `summary`: overall and category scores plus crawl totals. - `finding`: critical, warning, and notice messages. - `url`: status, response time, size, and content type for each HTML page. The default key-value store contains: - `REPORT`: compact JSON summary. - `REPORT_HTML`: interactive SiteOne report. - `REPORT_JSON`: complete SiteOne JSON report. If a pay-per-event budget covers only part of the audited pages, the Actor returns the paid page rows and summary, but withholds complete report files. ### Recommended pay-per-event pricing Configure these events in **Publication β†’ Monetization**: | Event | Suggested price | Trigger | | --- | ---: | --- | | `audit-start` | `$0.20` | Once before SiteOne starts | | `audited-page` | `$0.002` | Each HTML page or redirect added to the dataset | Start with **pay per event + platform usage** until real run costs are measured. After measuring at least 30 representative runs, include platform usage in the event prices for clearer customer pricing. ### Safety and responsible use - The Actor respects `robots.txt`; there is no option to disable it. - Request rate and concurrency have conservative hard limits. - Localhost, private networks, link-local addresses, reserved IPs, credentials in URLs, and non-standard ports are blocked. - Redirect targets receive the same safety validation. - Only audit websites you own or are authorized to test. - Do not use high request rates against third-party websites. The target website can change after DNS validation. Apify network isolation and platform security controls remain part of the overall defense; no application layer SSRF defense should be treated as absolute. ### Local development Requirements: - Node.js 22+ - A SiteOne Crawler 2.5.1 binary - Docker for the production-equivalent build Install and run tests: ```bash npm install npm run check ``` Run with a local SiteOne binary: ```bash SITEONE_BINARY=/absolute/path/to/siteone-crawler npm start ``` Build and run the container: ```bash docker build --tag siteone-website-audit . docker run --rm \ --volume "$PWD/storage:/usr/src/app/storage" \ siteone-website-audit ``` ### Publishing checklist 1. Create an Actor in Apify Console. 2. Push this repository using Apify CLI or connect a Git repository. 3. Build and run the example input. 4. Configure `audit-start` and `audited-page` PPE events. 5. Keep Actor permissions limited; the Actor needs no access to user resources beyond its default dataset and key-value store. 6. Add a Store icon, screenshots of the HTML report, support email, and SEO copy. 7. Test at 256 MB, 512 MB, and 1 GB; use the smallest reliable default. 8. Publish only after at least 10 websites pass and failure cases are documented. Ready-to-edit Store copy, keywords, launch examples, and pricing projections are available in [STORE\_LISTING.md](STORE_LISTING.md). ### Attribution SiteOne Crawler is created by JΓ‘n RegeΕ‘ and licensed under MIT. This wrapper is an independent project and is not an official SiteOne product. See [THIRD\_PARTY\_NOTICES.md](THIRD_PARTY_NOTICES.md). # Actor input Schema ## `startUrl` (type: `string`): The public website to audit. ## `preset` (type: `string`): Controls which sections are emphasized in the HTML report. All core analyzers still run. ## `singlePage` (type: `boolean`): Do not follow links to other pages on the same website. ## `device` (type: `string`): Select the desktop, mobile, or tablet user agent used during the audit. ## `maxVisitedUrls` (type: `integer`): Maximum number of pages and assets SiteOne may fetch. ## `maxDepth` (type: `integer`): 0 means unlimited depth within the URL limit. ## `requestsPerSecond` (type: `number`): Global request rate. Keep this low unless you own the target website. ## `workers` (type: `integer`): Maximum concurrent requests. ## `timeoutSecs` (type: `integer`): Per-request timeout. ## `removeQueryParameters` (type: `boolean`): Avoid duplicate crawl URLs and crawler traps caused by tracking parameters. ## `includePatterns` (type: `array`): Only discovered URLs matching at least one pattern are included. ## `excludePatterns` (type: `array`): Discovered URLs matching any pattern are skipped. ## Actor input object example ```json { "startUrl": "https://example.com", "preset": "full", "singlePage": false, "device": "desktop", "maxVisitedUrls": 100, "maxDepth": 0, "requestsPerSecond": 5, "workers": 2, "timeoutSecs": 10, "removeQueryParameters": true, "includePatterns": [], "excludePatterns": [] } ``` # Actor output Schema ## `results` (type: `string`): No description ## `summary` (type: `string`): No description ## `htmlReport` (type: `string`): No description ## `jsonReport` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrl": "https://example.com" }; // Run the Actor and wait for it to finish const run = await client.actor("hamzamihaidaniel/siteone-website-audit").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrl": "https://example.com" } # Run the Actor and wait for it to finish run = client.actor("hamzamihaidaniel/siteone-website-audit").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "startUrl": "https://example.com" }' | apify call hamzamihaidaniel/siteone-website-audit --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=hamzamihaidaniel/siteone-website-audit", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Website Quality Audit", "description": "Audit public websites for SEO, security, accessibility, performance, redirects, and technical issues. Get structured results plus interactive HTML and JSON reports.", "version": "0.1", "x-build-id": "kasuUKLB4mNqxOed1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hamzamihaidaniel~siteone-website-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hamzamihaidaniel-siteone-website-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/hamzamihaidaniel~siteone-website-audit/runs": { "post": { "operationId": "runs-sync-hamzamihaidaniel-siteone-website-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/hamzamihaidaniel~siteone-website-audit/run-sync": { "post": { "operationId": "run-sync-hamzamihaidaniel-siteone-website-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrl" ], "properties": { "startUrl": { "title": "Website URL", "type": "string", "description": "The public website to audit." }, "preset": { "title": "Report focus", "enum": [ "quick", "seo", "security", "accessibility", "performance", "full" ], "type": "string", "description": "Controls which sections are emphasized in the HTML report. All core analyzers still run.", "default": "full" }, "singlePage": { "title": "Audit only the start page", "type": "boolean", "description": "Do not follow links to other pages on the same website.", "default": false }, "device": { "title": "Device user agent", "enum": [ "desktop", "mobile", "tablet" ], "type": "string", "description": "Select the desktop, mobile, or tablet user agent used during the audit.", "default": "desktop" }, "maxVisitedUrls": { "title": "Maximum fetched URLs", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of pages and assets SiteOne may fetch.", "default": 100 }, "maxDepth": { "title": "Maximum page depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "0 means unlimited depth within the URL limit.", "default": 0 }, "requestsPerSecond": { "title": "Maximum requests per second", "minimum": 0.5, "maximum": 20, "type": "number", "description": "Global request rate. Keep this low unless you own the target website.", "default": 5 }, "workers": { "title": "Concurrent workers", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum concurrent requests.", "default": 2 }, "timeoutSecs": { "title": "Request timeout", "minimum": 2, "maximum": 60, "type": "integer", "description": "Per-request timeout.", "default": 10 }, "removeQueryParameters": { "title": "Remove query parameters", "type": "boolean", "description": "Avoid duplicate crawl URLs and crawler traps caused by tracking parameters.", "default": true }, "includePatterns": { "title": "Include URL patterns", "type": "array", "description": "Only discovered URLs matching at least one pattern are included.", "items": { "type": "string" }, "default": [] }, "excludePatterns": { "title": "Exclude URL patterns", "type": "array", "description": "Discovered URLs matching any pattern are skipped.", "items": { "type": "string" }, "default": [] } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```