{ "openapi": "3.0.1", "info": { "title": "SEO Audit Tool: On-Page Checks, Crawl & Broken Links", "description": "Audit web pages or crawl whole sites for on-page SEO: titles, meta descriptions, headings, canonicals, indexability, hreflang, Open Graph, JSON-LD, images without alt, mixed content and broken links. One row per page with issues and a 0-100 score. Pay only for pages audited.", "version": "1.0", "x-build-id": "33IwRXSE4SsOgcWfA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/private_image_hg9~seo-audit-onpage/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-private_image_hg9-seo-audit-onpage", "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/private_image_hg9~seo-audit-onpage/runs": { "post": { "operationId": "runs-sync-private_image_hg9-seo-audit-onpage", "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/private_image_hg9~seo-audit-onpage/run-sync": { "post": { "operationId": "run-sync-private_image_hg9-seo-audit-onpage", "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": "Pages or websites", "type": "array", "description": "One address per line: a full URL like https://www.example.com/pricing or a bare domain like example.com (https is used). In 'pages' mode each URL is audited once. In 'crawl' mode each one is the starting point of a crawl of its site. Repeats are audited once.", "items": { "type": "string" } }, "mode": { "title": "What to audit", "enum": [ "pages", "crawl" ], "type": "string", "description": "'pages': exactly the URLs you list (redirects are followed). 'crawl': start at each URL and follow links on the same site, breadth first, up to the page limit below. www.example.com and example.com count as one site; other subdomains like blog.example.com are separate sites.", "default": "pages" }, "maxPagesPerSite": { "title": "Max pages per site (crawl mode)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "In crawl mode, how many URLs of each site are checked, counting every row of the site (audited pages, redirects, error pages and pages robots.txt keeps the tool away from). Only audited HTML pages are charged.", "default": 50 }, "includeSitemap": { "title": "Also use the sitemap (crawl mode)", "type": "boolean", "description": "Read the site's sitemap (the Sitemap lines in robots.txt, or /sitemap.xml) and add its pages to the crawl, so pages no link points to are found too. The crawl takes turns between links found on pages and sitemap pages.", "default": false }, "checkLinks": { "title": "Check internal links for errors", "type": "boolean", "description": "Send a quick HEAD request to every internal link on each audited page (up to 100 per page, each link once per run) and list the broken ones (4xx, 5xx or no answer). No extra charge, but runs take longer.", "default": false }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages are fetched in parallel across all sites. Each site still gets no more requests per second than the setting below.", "default": 10 }, "maxRequestsPerSecondPerHost": { "title": "Requests per second per site", "minimum": 1, "maximum": 10, "type": "integer", "description": "The most requests started per second to one site (www and bare domain together). A robots.txt Crawl-delay slows this further, up to 10 seconds. Keep it low on small sites.", "default": 2 } } }, "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 } } } } } } } } } }