{ "openapi": "3.0.1", "info": { "title": "White Label SEO Audit Report", "description": "Crawl any website and get a white label SEO audit report with your own logo, agency name and brand colour. Every issue ranked by real search impact, not by number of warnings. Client-ready HTML plus clean JSON. Five languages.", "version": "0.1", "x-build-id": "CyGDhB6dWfQ6gs93o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/white-lion-studio~white-label-seo-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-white-lion-studio-white-label-seo-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/white-lion-studio~white-label-seo-audit/runs": { "post": { "operationId": "runs-sync-white-lion-studio-white-label-seo-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/white-lion-studio~white-label-seo-audit/run-sync": { "post": { "operationId": "run-sync-white-lion-studio-white-label-seo-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": [ "urlInicial" ], "properties": { "urlInicial": { "title": "Website URL", "type": "string", "description": "Where the crawl starts. Audit sites you own or have permission to audit. Defaults to example.com so the Actor always has something valid to run against.", "default": "https://example.com" }, "maxPaginas": { "title": "Maximum pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard limit on how many pages are analysed. You are charged per page analysed, so this is also your cost ceiling.", "default": 100 }, "respetarRobots": { "title": "Respect robots.txt", "type": "boolean", "description": "Recommended. Leave this on unless you own the site and know what you are doing.", "default": true }, "incluirSubdominios": { "title": "Include subdomains", "type": "boolean", "description": "Also crawl subdomains such as blog.yoursite.com or shop.yoursite.com. This increases the page count, and therefore the cost.", "default": false }, "idioma": { "title": "Report language", "enum": [ "en", "es", "fr", "de", "it" ], "type": "string", "description": "Language of the WHOLE report: issues, recommendations and headings. Scores are identical in every language.", "default": "en" }, "nombreAgencia": { "title": "Your agency name (white label)", "type": "string", "description": "Shown on the report as the author. Leave empty for an unbranded report." }, "logoUrl": { "title": "Your logo URL", "type": "string", "description": "Displayed at the top of the report. Must be a publicly accessible image." }, "colorMarca": { "title": "Brand colour", "type": "string", "description": "Hex colour used for links and accents in the report." } } }, "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 } } } } } } } } } }