{ "openapi": "3.0.1", "info": { "title": "Structured Data Validator: Schema Markup Checker", "description": "Schema markup validator for your pages. Checks JSON-LD, Microdata and RDFa against schema.org and the Google rich result rules for Product, Article, Event, Recipe, Local business and more. One row per URL with types, errors and warnings. Reads URLs or sitemaps, with a change-only mode.", "version": "0.1", "x-build-id": "ChFo3zfC9lmTPeaFn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~structured-data-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-structured-data-validator", "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/maliksaid~structured-data-validator/runs": { "post": { "operationId": "runs-sync-maliksaid-structured-data-validator", "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/maliksaid~structured-data-validator/run-sync": { "post": { "operationId": "run-sync-maliksaid-structured-data-validator", "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", "properties": { "startUrls": { "title": "Page URLs", "type": "array", "description": "Enter the pages to check. Each page gets one result row. Check only sites you own or have permission to audit.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Enter XML sitemap URLs. Every page listed in them is checked, up to the page limit. Sitemap index files are followed.", "default": [], "items": { "type": "string" } }, "useSitemaps": { "title": "Find sitemaps in robots.txt", "type": "boolean", "description": "Read robots.txt of each page URL's site and check the pages in the sitemaps it declares. Uses /sitemap.xml when robots.txt declares none.", "default": false }, "crawlLinks": { "title": "Follow links on the same site", "type": "boolean", "description": "Add same-site links found on checked pages, until the page limit is reached.", "default": false }, "includeItems": { "title": "Include raw items", "type": "boolean", "description": "Add the extracted JSON-LD, Microdata and RDFa items to each row, in JSON form. Rows get larger.", "default": false }, "changeOnly": { "title": "Change-only mode", "type": "boolean", "description": "Save only pages whose markup result changed since the last run with the same state key: new, broke, fixed, changed or markup removed. Schedule the Actor with this on to watch your markup. Every checked page is charged, saved or not.", "default": false }, "stateKey": { "title": "Change-only state key", "type": "string", "description": "Name of the memory that change-only mode uses. Use a different key for each site you watch.", "default": "default" }, "maxItems": { "title": "Maximum pages", "minimum": 0, "type": "integer", "description": "Stop after checking this many pages. The default keeps test runs short and cheap. Set 0 for no limit.", "default": 100 }, "maxRequestsPerMinute": { "title": "Requests per minute per site", "minimum": 1, "maximum": 300, "type": "integer", "description": "Limit how fast the Actor loads pages from one site. Raise it only for your own servers.", "default": 60 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Set how many pages load at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Choose a proxy if your site blocks data-center IP addresses. Most sites need none." } } }, "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 } } } } } } } } } }