{ "openapi": "3.0.1", "info": { "title": "SEO Audit Tool - Site Crawler with 0-100 Score", "description": "Crawl a website and get a 0-100 SEO score for every page and the whole site: meta, headings, robots, sitemap, broken links, images, schema. Export to CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "QJntUgZPWlNZZcRgQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~seo-audit-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-seo-audit-tool", "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/parseforge~seo-audit-tool/runs": { "post": { "operationId": "runs-sync-parseforge-seo-audit-tool", "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/parseforge~seo-audit-tool/run-sync": { "post": { "operationId": "run-sync-parseforge-seo-audit-tool", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Website URLs", "type": "array", "description": "The sites to audit. Each one gets its own crawl, one row per page and one site summary with a 0-100 score. Bare domains like example.com work too.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000. Counts audited pages across all sites; the site summary rows are free." }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most pages audited for each website. The crawl starts at the URL you gave and follows internal links breadth first.", "default": 25 }, "crawlLinks": { "title": "Follow internal links", "type": "boolean", "description": "On: crawl the site from each start URL. Off: audit only the URLs you listed.", "default": true }, "maxDepth": { "title": "Max link depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many clicks away from the start URL the crawl may go. 0 audits only the start URL.", "default": 6 }, "useSitemap": { "title": "Use the sitemap to find more pages", "type": "boolean", "description": "When the links run out before the page limit, continue with the URLs listed in the site's XML sitemap.", "default": true }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Also audit subdomains of the start URL (for example blog.example.com when you start at example.com).", "default": false }, "includeUrlPatterns": { "title": "Only crawl URLs matching", "type": "array", "description": "Optional. Text the URL must contain, or a regular expression wrapped in slashes such as /\\/blog\\//. The start URL is always audited.", "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Skip URLs matching", "type": "array", "description": "Text the URL contains (for example /tag/), or a regular expression wrapped in slashes such as /\\?page=\\d+/. Useful for archives and filters.", "items": { "type": "string" } }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs the site's robots.txt disallows and honour its Crawl-delay (up to 10 seconds). Turn off only for sites you own.", "default": true }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum pause between two requests to the same site.", "default": 300 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages are fetched at the same time. Lower it for small or slow servers.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for a page before giving up.", "default": 20 }, "userAgent": { "title": "User agent", "type": "string", "description": "Leave empty to identify as ParseForgeSEOAudit. Set your own string if your firewall only lets a specific agent through." }, "checkLinks": { "title": "Check links for errors", "type": "boolean", "description": "Request the links found on the pages (HEAD first) and report the broken ones per page. Pages the crawl already visited are not requested twice.", "default": true }, "checkExternalLinks": { "title": "Check links to other sites", "type": "boolean", "description": "Also check outgoing links to other websites. Off: only internal links.", "default": true }, "maxLinkChecks": { "title": "Max links checked per site", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Cap on distinct links requested per site, internal ones first. Pages that were crawled are always counted for free.", "default": 150 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }