{ "openapi": "3.0.1", "info": { "title": "Backlink Analyzer Pro", "description": "Analyze backlink profiles for domains and URLs in 14 modes: overview, link lists, anchors, referring domains, competitor gap, history, timeseries, and bulk comparison. Pay per result row on Apify.", "version": "2.0", "x-build-id": "3Nqwb2WRUdSrtldvf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winningsolutions~ws-backlink-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winningsolutions-ws-backlink-scraper", "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/winningsolutions~ws-backlink-scraper/runs": { "post": { "operationId": "runs-sync-winningsolutions-ws-backlink-scraper", "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/winningsolutions~ws-backlink-scraper/run-sync": { "post": { "operationId": "run-sync-winningsolutions-ws-backlink-scraper", "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": [ "targets" ], "properties": { "targets": { "title": "Domains / URLs", "minItems": 1, "type": "array", "description": "One entry per line. Domains and subdomains without https:// and www. (e.g. example.com), individual pages as full URLs (e.g. https://shop.example.com/category/). Up to 1000 entries.", "items": { "type": "string" } }, "includeSubdomains": { "title": "Include Subdomains", "type": "boolean", "description": "On: data for the full domain including all subdomains (e.g. example.com + blog.example.com). Off: exact target only.", "default": true }, "excludeInternalBacklinks": { "title": "Exclude Internal Backlinks", "type": "boolean", "description": "Links from subdomains of the same domain pointing to the target will not be counted.", "default": true }, "includeIndirectLinks": { "title": "Include Indirect Links", "type": "boolean", "description": "Counts links that point to the target via a redirect or canonical.", "default": true }, "mode": { "title": "Mode", "enum": [ "summary", "backlinks", "anchors", "referring_domains", "referring_networks", "domain_pages", "domain_pages_summary", "competitors", "domain_intersection", "page_intersection", "history", "timeseries_summary", "timeseries_new_lost", "bulk" ], "type": "string", "description": "Which analysis the actor performs. One run writes one mode. Open the Results tab first, then the tab that matches this mode. Other tabs hide empty columns.", "default": "summary" }, "bulkMetric": { "title": "Bulk Metric · mode \"Bulk Comparison\" only", "enum": [ "ranks", "backlinks", "spam_score", "referring_domains", "new_lost_backlinks", "new_lost_referring_domains" ], "type": "string", "description": "Which metric to retrieve for all targets in bulk.", "default": "referring_domains" }, "backlinksStatusType": { "title": "Backlink Status · mode \"Backlink List\" only", "enum": [ "all", "live", "lost" ], "type": "string", "description": "Which links to return: all, active only, or lost only.", "default": "live" }, "groupingMode": { "title": "Link Grouping · mode \"Backlink List\" only", "enum": [ "as_is", "one_per_domain", "one_per_anchor" ], "type": "string", "description": "All links, one link per referring domain, or one link per anchor.", "default": "as_is" }, "competitors": { "title": "Competitor Domains · gap modes only", "type": "array", "description": "Required for \"Domain Gap\" and \"Page Gap\" modes. The actor finds sources that link to these competitors but not to your target.", "items": { "type": "string" } }, "linkType": { "title": "Link Type", "enum": [ "all", "dofollow", "nofollow" ], "type": "string", "description": "Restrict results to a specific link type.", "default": "all" }, "minDomainRank": { "title": "Min. Domain Rank", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Only include referring domains at or above this rank value.", "default": 0 }, "maxSpamScore": { "title": "Max. Spam Score (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Exclude referring domains with a spam score above this threshold.", "default": 100 }, "rankScale": { "title": "Rank Scale", "enum": [ "one_thousand", "one_hundred" ], "type": "string", "description": "Scale in which rank values are returned.", "default": "one_thousand" }, "tldFilter": { "title": "TLD Filter", "type": "array", "description": "Only include sources with these top-level domains (e.g. de, at, ch). Leave empty for all.", "items": { "type": "string" } }, "languageFilter": { "title": "Source Page Language", "type": "string", "description": "ISO language code to filter by (e.g. de, en). Leave empty for all." }, "excludeDomains": { "title": "Exclude Domains", "type": "array", "description": "Referring domains that should never appear in results (blocklist).", "items": { "type": "string" } }, "maxResultsPerTarget": { "title": "Max. Results per Target", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit per target. Hard-capped at 1000 to control run size.", "default": 100 }, "orderBy": { "title": "Sort Order", "type": "string", "description": "Field and direction, e.g. rank,desc or domain_from_rank,desc.", "default": "rank,desc" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Start date (YYYY-MM-DD). Earliest available: 2019-01-30." }, "dateTo": { "title": "Date To", "type": "string", "description": "End date (YYYY-MM-DD). Leave empty for today." }, "groupRange": { "title": "Timeseries Grouping", "enum": [ "day", "week", "month", "year" ], "type": "string", "description": "Grouping interval for timeseries results.", "default": "month" }, "deduplicateByDomain": { "title": "Deduplicate by Domain", "type": "boolean", "description": "Write only one entry per referring domain into the dataset.", "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 } } }, "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 } } } } } } } } } }