{ "openapi": "3.0.1", "info": { "title": "Own-Site SEO Audit: Catch Broken Links, Hreflang & Canonicals", "description": "Crawl your own site and get one JSON row per page: titles, canonicals, hreflang, alt text, broken links, with issue codes. Pay per audited page.", "version": "0.1", "x-build-id": "FjMyPcebtuz07yAQI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/licensedpipe~seo-audit-own-site/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-licensedpipe-seo-audit-own-site", "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/licensedpipe~seo-audit-own-site/runs": { "post": { "operationId": "runs-sync-licensedpipe-seo-audit-own-site", "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/licensedpipe~seo-audit-own-site/run-sync": { "post": { "operationId": "run-sync-licensedpipe-seo-audit-own-site", "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", "confirmOwnership" ], "properties": { "startUrls": { "title": "Start URLs (your own site)", "maxItems": 20, "type": "array", "description": "Pages to audit and start crawling from. Only these hosts are fetched (max 20 URLs, max 3 hosts). Redirects to other hosts are reported, not followed. Use the exact host you want audited (www and non-www are different hosts).", "items": { "type": "string" } }, "confirmOwnership": { "title": "I own this website or have permission to audit it", "type": "boolean", "description": "Required. The actor sends real HTTP requests to the site (<= 1 request per second, robots.txt respected). You are responsible for having the right to audit it.", "default": false }, "crawlInternalLinks": { "title": "Follow internal links", "type": "boolean", "description": "Follow same-host links found on the pages (breadth-first) until the page limit. If off, only the start URLs are audited.", "default": true }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of URLs fetched and returned (each result is billed). Default 50, hard cap 500. At 1 request/s, 500 pages take about 9 minutes or longer if robots.txt asks for a Crawl-delay.", "default": 50 }, "maxDepth": { "title": "Max link depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many link levels from the start URLs to follow.", "default": 3 }, "includeTitleAndDescriptionText": { "title": "Include title and meta description text", "type": "boolean", "description": "Return the text of and meta description (e-mail addresses, phone numbers and ID-like numbers are masked, but names cannot be detected). Off by default (data minimisation): you then get only lengths and duplicate flags.", "default": false }, "maxRuntimeSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "The run stops cleanly after this time and returns what it has.", "default": 900 }, "keepQueryStrings": { "title": "Keep query strings in output URLs (off = privacy default)", "type": "boolean", "description": "By default everything after \"?\" in URLs written to the dataset and run summary is replaced by a short salted marker (?q~xxxxxxxx), because query strings can carry tokens, e-mail addresses or user IDs. Requests are still sent with the full URL. Turn on only if you need the original query strings and know they contain no personal data.", "default": 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 } } } } } } } } } }