{ "openapi": "3.0.1", "info": { "title": "Website Similarity: Compare Your Site With Others", "description": "Compare your site against sites you choose: copied wording, copied design, same template. Scores copied sentences, page layout, look, code and shared files, with plain-English reasons and a side-by-side picture. You list the sites; nothing is searched. No login. Pay only for the sites compared.", "version": "0.1", "x-build-id": "T3VhBWoLMyNu53ooD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~website-similarity/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-website-similarity", "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/locaihost~website-similarity/runs": { "post": { "operationId": "runs-sync-locaihost-website-similarity", "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/locaihost~website-similarity/run-sync": { "post": { "operationId": "run-sync-locaihost-website-similarity", "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": "Your websites", "type": "array", "description": "Your site, or any site you want to compare against others. One address per line, up to 50. Each is read (home page and up to three linked pages), then compared with the sites you list below.", "items": { "type": "string" } }, "compareWith": { "title": "Compare against these sites", "type": "array", "description": "Required. The sites to compare your websites with, one address per line, up to 100. Each is scored and returned, even when the score is low.", "items": { "type": "string" } }, "checks": { "title": "What to compare", "type": "array", "description": "Content looks for copied sentences and shared topics. Design looks at page layout, colours and fonts, custom code names and shared image files, and spots plain template matches. Design checks open each page in a browser, so they take longer.", "items": { "type": "string", "enum": [ "content", "design" ], "enumTitles": [ "Content (copied sentences)", "Design (layout, look, code, files)" ] }, "default": [ "content", "design" ] }, "minScore": { "title": "Minimum similarity score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Used for the look-alike count in the summary report (0 to 100). Every site you list is returned with its score.", "default": 40 }, "pagesPerSite": { "title": "Pages to read on your website", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages of each website you check are read (home page plus linked about, services and product pages), 1 to 10. Copiers usually take several pages, so more pages find more copied sentences. Compared sites are read up to 3 pages.", "default": 4 }, "onlyNew": { "title": "Only new matches since the last run (monitor)", "type": "boolean", "description": "Remember what was already returned for this website and return only new matches or ones whose score rose by 15 points or more. Schedule the Actor weekly to watch your list. The memory is a named store in your account.", "default": false }, "watchName": { "title": "Monitor name", "type": "string", "description": "Names the memory used by 'Only new matches', so you can keep several watch lists apart. Leave empty for the default.", "default": "" }, "saveImages": { "title": "Save side-by-side images", "type": "boolean", "description": "For scores of 60 or more, save a picture of your page next to theirs. The link is in the row.", "default": true }, "makeReports": { "title": "Write PDF evidence reports", "type": "boolean", "description": "For scores of 60 or more, write a PDF with the scores, your copied sentences, Internet Archive first-seen dates and the side-by-side picture. Useful for a complaint to a host or to Google. The link is in the row.", "default": true } } }, "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 } } } } } } } } } }