{ "openapi": "3.0.1", "info": { "title": "Website SEO Audit for Agencies: Crawler, Reports & Alerts", "description": "Crawl client sites and run 77 SEO checks (titles, canonicals, hreflang, noindex, redirects, broken links, sitemaps, structured data). Get a prioritized fix plan, a white-label HTML report and alerts when SEO-critical things change. Respects robots.txt. Not affiliated with Google.", "version": "1.0", "x-build-id": "fy4rkJTubHKTmdZbh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hani-tools~seo-audit-for-agencies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hani-tools-seo-audit-for-agencies", "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/hani-tools~seo-audit-for-agencies/runs": { "post": { "operationId": "runs-sync-hani-tools-seo-audit-for-agencies", "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/hani-tools~seo-audit-for-agencies/run-sync": { "post": { "operationId": "run-sync-hani-tools-seo-audit-for-agencies", "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": "Sites to audit", "type": "array", "description": "One start URL per site (usually the home page). Several sites can be audited in one run; each gets its own report. Only audit sites you own or are authorised to audit (e.g. client sites). robots.txt is always respected.", "default": [ "https://crawlee.dev/" ], "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit of HTML pages analysed (and billed) per site. Error pages, redirects and robots-blocked URLs are free and do not count.", "default": 25 }, "useSitemap": { "title": "Use the XML sitemap", "type": "boolean", "description": "Read the sitemap (from robots.txt, or /sitemap.xml) to find pages and to check that it matches the site (broken, redirecting, noindex or orphan URLs).", "default": true }, "sitemapUrls": { "title": "Sitemap URLs (optional)", "type": "array", "description": "Use these sitemaps instead of auto-discovery.", "items": { "type": "string" } }, "maxDepth": { "title": "Max click depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "Do not follow links more than this many clicks from the start URL.", "default": 10 }, "samplePerPathPattern": { "title": "Sample N pages per section", "minimum": 0, "maximum": 1000, "type": "integer", "description": "0 = off. For example 5 analyses at most 5 pages per first path segment (/blog/*, /products/*), so big sites are covered evenly within the page limit.", "default": 0 }, "includeUrlPatterns": { "title": "Only URLs containing", "type": "array", "description": "Plain text, * wildcards or /regex/. Start URLs are always included.", "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Skip URLs containing", "type": "array", "description": "Plain text, * wildcards or /regex/, e.g. /tag/, ?sort=, /page/.", "items": { "type": "string" } }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Treat blog.example.com etc. as part of example.com.", "default": false }, "checkCanonicalTargets": { "title": "Check link, canonical and hreflang targets", "type": "boolean", "description": "Send a light HEAD request to targets that were not crawled (up to the limit below) to detect broken links and bad canonicals. These requests are free.", "default": true }, "maxExtraChecks": { "title": "Max extra target checks per site", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Upper limit for the free HEAD checks of uncrawled link/canonical/hreflang targets. Default: 2 × max pages per site, at most 200." }, "thresholds": { "title": "Thresholds (optional)", "type": "object", "description": "Override heuristic limits: titleMax, titlePxMax, titleMin, descMax, descMin, thinWords, maxDepth, htmlMaxKb, maxResources, slowTtfbMs, jsSuspectWords." }, "compareWithPrevious": { "title": "Compare with the previous audit", "type": "boolean", "description": "Stores a baseline per site and reports new/fixed issues and critical changes (noindex added, page now 4xx/5xx, canonical changed, robots.txt newly blocking, sitemap gone, title removed, new broken links).", "default": true }, "baselineName": { "title": "Baseline name", "type": "string", "description": "Use different names to keep separate histories (e.g. one per client or schedule).", "default": "default" }, "webhookUrl": { "title": "Alert webhook URL", "type": "string", "description": "POSTs a JSON summary when at least one critical change is found (Slack/Zapier/Make compatible endpoint)." }, "failRunOnCritical": { "title": "Fail the run on critical changes", "type": "boolean", "description": "Useful in CI/deploy pipelines. Results are still saved.", "default": false }, "newBrokenLinksThreshold": { "title": "Alert when at least N new broken internal links", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Alert when at least N new broken internal links.", "default": 3 }, "reportEnabled": { "title": "Create the white-label client report", "type": "boolean", "description": "One self-contained HTML report per site (billed as one site-report event) plus a free portfolio overview.", "default": true }, "brandName": { "title": "Your agency name", "type": "string", "description": "Shown in the report header and footer." }, "clientName": { "title": "Client name", "type": "string", "description": "Shown in the report header." }, "logoUrl": { "title": "Logo URL", "type": "string", "description": "https:// URL of your logo (PNG/SVG)." }, "accentColor": { "title": "Accent colour", "type": "string", "description": "Hex colour such as #2255aa.", "default": "#2255aa" }, "perHostDelaySecs": { "title": "Delay between requests to one host (seconds)", "minimum": 0.5, "maximum": 30, "type": "number", "description": "Politeness delay; minimum 0.5 s. A longer robots.txt Crawl-delay (up to 10 s) is honoured automatically.", "default": 1 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Give up on a request after this many seconds (not charged).", "default": 20 }, "maxHtmlMb": { "title": "Max HTML size per page (MB)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages larger than this are cut at this size and flagged.", "default": 5 }, "maxConcurrentSites": { "title": "Sites crawled in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Each site is still crawled one request at a time.", "default": 3 } } }, "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 } } } } } } } } } }